openapi: 3.0.3 info: title: Infisical Admin App Connections 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: App Connections paths: /api/v1/app-connections/options: get: operationId: listAppConnectionOptions tags: - App Connections description: List the available App Connection Options. parameters: - schema: type: string enum: - secret-manager - cert-manager - kms - ssh - secret-scanning - pam - ai in: query name: projectType required: false responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnectionOptions: type: array items: anyOf: - type: object properties: name: type: string enum: - AWS app: type: string enum: - aws methods: type: array items: type: string enum: - assume-role - access-key accessKeyId: type: string required: - name - app - methods additionalProperties: false title: AWS - type: object properties: name: type: string enum: - GitHub app: type: string enum: - github methods: type: array items: type: string enum: - oauth - github-app - pat oauthClientId: type: string appClientSlug: type: string required: - name - app - methods additionalProperties: false title: GitHub - type: object properties: name: type: string enum: - GitHub Radar app: type: string enum: - github-radar methods: type: array items: type: string enum: - github-app appClientSlug: type: string required: - name - app - methods additionalProperties: false title: GitHub Radar - type: object properties: name: type: string enum: - GCP app: type: string enum: - gcp methods: type: array items: type: string enum: - service-account-impersonation required: - name - app - methods additionalProperties: false title: GCP - type: object properties: name: type: string enum: - Azure Key Vault app: type: string enum: - azure-key-vault methods: type: array items: type: string enum: - oauth - client-secret - certificate oauthClientId: type: string required: - name - app - methods additionalProperties: false title: Azure Key Vault - type: object properties: name: type: string enum: - Azure App Configuration app: type: string enum: - azure-app-configuration methods: type: array items: type: string enum: - oauth - client-secret oauthClientId: type: string required: - name - app - methods additionalProperties: false title: Azure App Configuration - type: object properties: name: type: string enum: - Azure DevOps app: type: string enum: - azure-devops methods: type: array items: type: string enum: - oauth - access-token - client-secret oauthClientId: type: string required: - name - app - methods additionalProperties: false title: Azure DevOps - type: object properties: name: type: string enum: - Databricks app: type: string enum: - databricks methods: type: array items: type: string enum: - service-principal required: - name - app - methods additionalProperties: false title: Databricks - type: object properties: name: type: string enum: - Humanitec app: type: string enum: - humanitec methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Humanitec - type: object properties: name: type: string enum: - Terraform Cloud app: type: string enum: - terraform-cloud methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Terraform Cloud - type: object properties: name: type: string enum: - Vercel app: type: string enum: - vercel methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Vercel - type: object properties: name: type: string enum: - PostgreSQL app: type: string enum: - postgres methods: type: array items: type: string enum: - username-and-password supportsPlatformManagement: type: boolean enum: - true required: - name - app - methods - supportsPlatformManagement additionalProperties: false title: PostgreSQL - type: object properties: name: type: string enum: - Microsoft SQL Server app: type: string enum: - mssql methods: type: array items: type: string enum: - username-and-password supportsPlatformManagement: type: boolean enum: - true required: - name - app - methods - supportsPlatformManagement additionalProperties: false title: Microsoft SQL Server - type: object properties: name: type: string enum: - MySQL app: type: string enum: - mysql methods: type: array items: type: string enum: - username-and-password supportsPlatformManagement: type: boolean enum: - true required: - name - app - methods - supportsPlatformManagement additionalProperties: false title: MySQL - type: object properties: name: type: string enum: - Camunda app: type: string enum: - camunda methods: type: array items: type: string enum: - client-credentials required: - name - app - methods additionalProperties: false title: Camunda - type: object properties: name: type: string enum: - Auth0 app: type: string enum: - auth0 methods: type: array items: type: string enum: - client-credentials required: - name - app - methods additionalProperties: false title: Auth0 - type: object properties: name: type: string enum: - HCVault app: type: string enum: - hashicorp-vault methods: type: array items: type: string enum: - access-token - app-role required: - name - app - methods additionalProperties: false title: Hashicorp Vault - type: object properties: name: type: string enum: - Azure Client Secrets app: type: string enum: - azure-client-secrets methods: type: array items: type: string enum: - oauth - client-secret - certificate oauthClientId: type: string required: - name - app - methods additionalProperties: false title: Azure Client Secrets - type: object properties: name: type: string enum: - Windmill app: type: string enum: - windmill methods: type: array items: type: string enum: - access-token required: - name - app - methods additionalProperties: false title: Windmill - type: object properties: name: type: string enum: - LDAP app: type: string enum: - ldap methods: type: array items: type: string enum: - simple-bind required: - name - app - methods additionalProperties: false title: LDAP - type: object properties: name: type: string enum: - TeamCity app: type: string enum: - teamcity methods: type: array items: type: string enum: - access-token required: - name - app - methods additionalProperties: false title: TeamCity - type: object properties: name: type: string enum: - OCI app: type: string enum: - oci methods: type: array items: type: string enum: - access-key required: - name - app - methods additionalProperties: false title: OCI - type: object properties: name: type: string enum: - OracleDB app: type: string enum: - oracledb methods: type: array items: type: string enum: - username-and-password supportsPlatformManagement: type: boolean enum: - true required: - name - app - methods - supportsPlatformManagement additionalProperties: false title: OracleDB - type: object properties: name: type: string enum: - 1Password app: type: string enum: - 1password methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: 1Password - type: object properties: name: type: string enum: - Heroku app: type: string enum: - heroku methods: type: array items: type: string enum: - auth-token - oauth oauthClientId: type: string required: - name - app - methods additionalProperties: false title: Heroku - type: object properties: name: type: string enum: - Render app: type: string enum: - render methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Render - type: object properties: name: type: string enum: - Fly.io app: type: string enum: - flyio methods: type: array items: type: string enum: - access-token required: - name - app - methods additionalProperties: false title: Fly.io - type: object properties: name: type: string enum: - GitLab app: type: string enum: - gitlab methods: type: array items: type: string enum: - oauth - access-token oauthClientId: type: string required: - name - app - methods additionalProperties: false title: GitLab - type: object properties: name: type: string enum: - Cloudflare app: type: string enum: - cloudflare methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Cloudflare - type: object properties: name: type: string enum: - Bitbucket app: type: string enum: - bitbucket methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Bitbucket - type: object properties: name: type: string enum: - Zabbix app: type: string enum: - zabbix methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Zabbix - type: object properties: name: type: string enum: - Railway app: type: string enum: - railway methods: type: array items: type: string enum: - account-token - project-token - team-token required: - name - app - methods additionalProperties: false title: Railway - type: object properties: name: type: string enum: - Checkly app: type: string enum: - checkly methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Checkly - type: object properties: name: type: string enum: - CircleCI app: type: string enum: - circleci methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: CircleCI - type: object properties: name: type: string enum: - Supabase app: type: string enum: - supabase methods: type: array items: type: string enum: - access-token required: - name - app - methods additionalProperties: false title: Supabase - type: object properties: name: type: string enum: - Digital Ocean app: type: string enum: - digital-ocean methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: DigitalOcean App Platform - type: object properties: name: type: string enum: - Netlify app: type: string enum: - netlify methods: type: array items: type: string enum: - access-token required: - name - app - methods additionalProperties: false title: Netlify - type: object properties: name: type: string enum: - Northflank app: type: string enum: - northflank methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Northflank - type: object properties: name: type: string enum: - Okta app: type: string enum: - okta methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Okta - type: object properties: name: type: string enum: - Azure ADCS app: type: string enum: - azure-adcs methods: type: array items: type: string enum: - username-password required: - name - app - methods additionalProperties: false title: Azure ADCS - type: object properties: name: type: string enum: - Redis app: type: string enum: - redis methods: type: array items: type: string enum: - username-and-password supportsPlatformManagement: type: boolean enum: - false required: - name - app - methods - supportsPlatformManagement additionalProperties: false title: Redis - type: object properties: name: type: string enum: - MongoDB app: type: string enum: - mongodb methods: type: array items: type: string enum: - username-and-password supportsPlatformManagement: type: boolean enum: - false required: - name - app - methods - supportsPlatformManagement additionalProperties: false - type: object properties: name: type: string enum: - Laravel Forge app: type: string enum: - laravel-forge methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Laravel Forge - type: object properties: name: type: string enum: - Chef app: type: string enum: - chef methods: type: array items: type: string enum: - user-key required: - name - app - methods additionalProperties: false title: Chef - type: object properties: name: type: string enum: - DNS Made Easy app: type: string enum: - dns-made-easy methods: type: array items: type: string enum: - api-key-secret required: - name - app - methods additionalProperties: false title: DNS Made Easy - type: object properties: name: type: string enum: - Azure DNS app: type: string enum: - azure-dns methods: type: array items: type: string enum: - client-secret required: - name - app - methods additionalProperties: false title: Azure DNS - type: object properties: name: type: string enum: - Octopus Deploy app: type: string enum: - octopus-deploy methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Octopus Deploy - type: object properties: name: type: string enum: - Windows app: type: string enum: - smb methods: type: array items: type: string enum: - credentials required: - name - app - methods additionalProperties: false title: SMB - type: object properties: name: type: string enum: - SSH app: type: string enum: - ssh methods: type: array items: type: string enum: - password - ssh-key required: - name - app - methods additionalProperties: false title: SSH - type: object properties: name: type: string enum: - DBT app: type: string enum: - dbt methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: DBT - type: object properties: name: type: string enum: - OpenRouter app: type: string enum: - open-router methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: OpenRouter - type: object properties: name: type: string enum: - Azure Entra ID app: type: string enum: - azure-entra-id methods: type: array items: type: string enum: - client-secret required: - name - app - methods additionalProperties: false title: Azure Entra ID - type: object properties: name: type: string enum: - Venafi TLS Protect Cloud app: type: string enum: - venafi methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Venafi TLS Protect Cloud - type: object properties: name: type: string enum: - Venafi TPP app: type: string enum: - venafi-tpp methods: type: array items: type: string enum: - oauth required: - name - app - methods additionalProperties: false title: Venafi TPP - type: object properties: name: type: string enum: - Infisical app: type: string enum: - external-infisical methods: type: array items: type: string enum: - machine-identity-universal-auth required: - name - app - methods additionalProperties: false title: Infisical - type: object properties: name: type: string enum: - Doppler app: type: string enum: - doppler methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Doppler - type: object properties: name: type: string enum: - NetScaler app: type: string enum: - netscaler methods: type: array items: type: string enum: - basic-auth required: - name - app - methods additionalProperties: false title: NetScaler - type: object properties: name: type: string enum: - Anthropic app: type: string enum: - anthropic methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Anthropic - type: object properties: name: type: string enum: - OVH app: type: string enum: - ovh methods: type: array items: type: string enum: - certificate required: - name - app - methods additionalProperties: false title: OVH - type: object properties: name: type: string enum: - Devin app: type: string enum: - devin methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Devin - type: object properties: name: type: string enum: - Ona app: type: string enum: - ona methods: type: array items: type: string enum: - personal-access-token required: - name - app - methods additionalProperties: false title: Ona - type: object properties: name: type: string enum: - DigiCert app: type: string enum: - digicert methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: DigiCert - type: object properties: name: type: string enum: - GoDaddy app: type: string enum: - godaddy methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: GoDaddy - type: object properties: name: type: string enum: - Travis CI app: type: string enum: - travis-ci methods: type: array items: type: string enum: - api-token required: - name - app - methods additionalProperties: false title: Travis CI - type: object properties: name: type: string enum: - Salesforce app: type: string enum: - salesforce methods: type: array items: type: string enum: - client-credentials required: - name - app - methods additionalProperties: false title: Salesforce - type: object properties: name: type: string enum: - Snowflake app: type: string enum: - snowflake methods: type: array items: type: string enum: - username-and-token required: - name - app - methods additionalProperties: false title: Snowflake - type: object properties: name: type: string enum: - Datadog app: type: string enum: - datadog methods: type: array items: type: string enum: - api-key required: - name - app - methods additionalProperties: false title: Datadog - type: object properties: name: type: string enum: - F5 BIG-IP app: type: string enum: - f5-big-ip methods: type: array items: type: string enum: - basic-auth required: - name - app - methods additionalProperties: false title: F5 BIG-IP - type: object properties: name: type: string enum: - Convex app: type: string enum: - convex methods: type: array items: type: string enum: - personal-access-token required: - name - app - methods additionalProperties: false title: Convex required: - appConnectionOptions 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/app-connections: get: operationId: listAppConnections tags: - App Connections description: List all the App Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list App Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnections 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/app-connections/aws: get: operationId: listAwsAppConnections tags: - App Connections description: List the AWS Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list AWS Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnections 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 post: operationId: createAwsAppConnection tags: - App Connections description: Create an AWS Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - assume-role description: The method used to authenticate with AWS. credentials: type: object properties: roleArn: type: string minLength: 1 stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. required: - roleArn additionalProperties: false description: The credentials used to connect with AWS. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - access-key description: The method used to authenticate with AWS. credentials: type: object properties: accessKeyId: type: string minLength: 1 secretAccessKey: type: string minLength: 1 required: - accessKeyId - secretAccessKey additionalProperties: false description: The credentials used to connect with AWS. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the AWS Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the AWS Connection. projectId: type: string description: The ID of the project to create the AWS Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for AWS Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for AWS Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for AWS Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for AWS Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for AWS Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnection 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/app-connections/aws/available: get: operationId: listAwsAvailableAppConnections tags: - App Connections description: List the AWS Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list AWS Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/aws/{connectionId}: get: operationId: getAwsAppConnection tags: - App Connections description: Get the specified AWS Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the AWS Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnection 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: updateAwsAppConnection tags: - App Connections description: Update the specified AWS Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: accessKeyId: type: string minLength: 1 secretAccessKey: type: string minLength: 1 required: - accessKeyId - secretAccessKey additionalProperties: false - type: object properties: roleArn: type: string minLength: 1 stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. required: - roleArn additionalProperties: false description: The credentials used to connect with AWS. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the AWS Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the AWS Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for AWS Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for AWS Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for AWS Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for AWS Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for AWS Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the AWS Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnection 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: deleteAwsAppConnection tags: - App Connections description: Delete the specified AWS Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the AWS Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnection 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/app-connections/aws/connection-name/{connectionName}: get: operationId: getAwsAppConnectionByName tags: - App Connections description: Get the specified AWS Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the AWS Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the AWS Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnection 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/app-connections/aws/{connectionId}/rotate-credentials: post: operationId: rotateAwsAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified AWS Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the AWS Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - assume-role credentials: type: object properties: stsEndpoint: type: string format: uri pattern: ^https\:\/\/ description: An optional custom endpoint URL for the AWS STS API to use when connecting with AWS. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Assume Role) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - aws method: type: string enum: - access-key credentials: type: object properties: accessKeyId: type: string minLength: 1 required: - accessKeyId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: AWS (Access Key) required: - appConnection 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/app-connections/github: get: operationId: listGitHubAppConnections tags: - App Connections description: List the GitHub Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GitHub Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnections 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 post: operationId: createGitHubAppConnection tags: - App Connections description: Create a GitHub Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - github-app description: The method used to authenticate with GitHub. credentials: anyOf: - type: object properties: code: type: string minLength: 1 installationsToken: type: string minLength: 1 installationId: type: string minLength: 1 gitHubAppId: type: string format: uuid nullable: true instanceType: type: string enum: - server host: type: string minLength: 1 required: - installationId - instanceType - host additionalProperties: false - type: object properties: code: type: string minLength: 1 installationsToken: type: string minLength: 1 installationId: type: string minLength: 1 gitHubAppId: type: string format: uuid nullable: true instanceType: type: string enum: - cloud host: type: string required: - installationId additionalProperties: false description: The credentials used to connect with GitHub. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with GitHub. credentials: anyOf: - type: object properties: code: type: string minLength: 1 instanceType: type: string enum: - server host: type: string minLength: 1 required: - code - instanceType - host additionalProperties: false - type: object properties: code: type: string minLength: 1 instanceType: type: string enum: - cloud host: type: string required: - code additionalProperties: false description: The credentials used to connect with GitHub. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - pat description: The method used to authenticate with GitHub. credentials: anyOf: - type: object properties: personalAccessToken: type: string minLength: 1 instanceType: type: string enum: - server host: type: string minLength: 1 required: - personalAccessToken - instanceType - host additionalProperties: false - type: object properties: personalAccessToken: type: string minLength: 1 instanceType: type: string enum: - cloud host: type: string required: - personalAccessToken additionalProperties: false description: The credentials used to connect with GitHub. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the GitHub Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the GitHub Connection. projectId: type: string description: The ID of the project to create the GitHub Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GitHub Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GitHub Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnection 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/app-connections/github/available: get: operationId: listGitHubAvailableAppConnections tags: - App Connections description: List the GitHub Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GitHub Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/github/{connectionId}: get: operationId: getGitHubAppConnection tags: - App Connections description: Get the specified GitHub Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnection 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: updateGitHubAppConnection tags: - App Connections description: Update the specified GitHub Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - anyOf: - type: object properties: code: type: string minLength: 1 installationsToken: type: string minLength: 1 installationId: type: string minLength: 1 gitHubAppId: type: string format: uuid nullable: true instanceType: type: string enum: - server host: type: string minLength: 1 required: - installationId - instanceType - host additionalProperties: false - type: object properties: code: type: string minLength: 1 installationsToken: type: string minLength: 1 installationId: type: string minLength: 1 gitHubAppId: type: string format: uuid nullable: true instanceType: type: string enum: - cloud host: type: string required: - installationId additionalProperties: false - anyOf: - type: object properties: code: type: string minLength: 1 instanceType: type: string enum: - server host: type: string minLength: 1 required: - code - instanceType - host additionalProperties: false - type: object properties: code: type: string minLength: 1 instanceType: type: string enum: - cloud host: type: string required: - code additionalProperties: false - anyOf: - type: object properties: personalAccessToken: type: string minLength: 1 instanceType: type: string enum: - server host: type: string minLength: 1 required: - personalAccessToken - instanceType - host additionalProperties: false - type: object properties: personalAccessToken: type: string minLength: 1 instanceType: type: string enum: - cloud host: type: string required: - personalAccessToken additionalProperties: false description: The credentials used to connect with GitHub. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the GitHub Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the GitHub Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GitHub Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GitHub Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnection 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: deleteGitHubAppConnection tags: - App Connections description: Delete the specified GitHub Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnection 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/app-connections/github/connection-name/{connectionName}: get: operationId: getGitHubAppConnectionByName tags: - App Connections description: Get the specified GitHub Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the GitHub Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the GitHub Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnection 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/app-connections/github/{connectionId}/rotate-credentials: post: operationId: rotateGitHubAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified GitHub Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - github-app credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string gitHubAppId: type: string format: uuid nullable: true additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (GitHub App) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - oauth credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github method: type: string enum: - pat credentials: type: object properties: instanceType: anyOf: - type: string enum: - server - type: string enum: - cloud host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub (Personal Access Token) required: - appConnection 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/app-connections/github-radar: get: operationId: listGitHubRadarAppConnections tags: - App Connections description: List the GitHub Radar Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GitHub Radar Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnections 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 post: operationId: createGitHubRadarAppConnection tags: - App Connections description: Create a GitHub Radar Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - github-app description: The method used to authenticate with GitHub Radar. credentials: type: object properties: code: type: string minLength: 1 installationId: type: string minLength: 1 required: - code - installationId additionalProperties: false description: The credentials used to connect with GitHub Radar. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the GitHub Radar Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the GitHub Radar Connection. projectId: type: string description: The ID of the project to create the GitHub Radar Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GitHub Radar Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Radar Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Radar Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GitHub Radar Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Radar Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnection 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/app-connections/github-radar/available: get: operationId: listGitHubRadarAvailableAppConnections tags: - App Connections description: List the GitHub Radar Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GitHub Radar Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - github-radar name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/github-radar/{connectionId}: get: operationId: getGitHubRadarAppConnection tags: - App Connections description: Get the specified GitHub Radar Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Radar Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnection 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: updateGitHubRadarAppConnection tags: - App Connections description: Update the specified GitHub Radar Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: code: type: string minLength: 1 installationId: type: string minLength: 1 required: - code - installationId additionalProperties: false description: The credentials used to connect with GitHub Radar. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the GitHub Radar Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the GitHub Radar Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GitHub Radar Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Radar Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Radar Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GitHub Radar Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitHub Radar Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Radar Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnection 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: deleteGitHubRadarAppConnection tags: - App Connections description: Delete the specified GitHub Radar Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Radar Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnection 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/app-connections/github-radar/connection-name/{connectionName}: get: operationId: getGitHubRadarAppConnectionByName tags: - App Connections description: Get the specified GitHub Radar Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the GitHub Radar Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the GitHub Radar Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnection 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/app-connections/github-radar/{connectionId}/rotate-credentials: post: operationId: rotateGitHubRadarAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified GitHub Radar Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitHub Radar Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - github-radar method: type: string enum: - github-app credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitHub Radar (GitHub App) required: - appConnection 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/app-connections/gcp: get: operationId: listGcpAppConnections tags: - App Connections description: List the GCP Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GCP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnections 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 post: operationId: createGcpAppConnection tags: - App Connections description: Create a GCP Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - service-account-impersonation description: The method used to authenticate with GCP. credentials: type: object properties: serviceAccountEmail: type: string format: email minLength: 1 required: - serviceAccountEmail additionalProperties: false description: The credentials used to connect with GCP. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the GCP Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the GCP Connection. projectId: type: string description: The ID of the project to create the GCP Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GCP Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GCP Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GCP Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GCP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GCP Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnection 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/app-connections/gcp/available: get: operationId: listGcpAvailableAppConnections tags: - App Connections description: List the GCP Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GCP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/gcp/{connectionId}: get: operationId: getGcpAppConnection tags: - App Connections description: Get the specified GCP Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GCP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnection 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: updateGcpAppConnection tags: - App Connections description: Update the specified GCP Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: serviceAccountEmail: type: string format: email minLength: 1 required: - serviceAccountEmail additionalProperties: false description: The credentials used to connect with GCP. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the GCP Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the GCP Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GCP Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GCP Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GCP Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GCP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GCP Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GCP Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnection 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: deleteGcpAppConnection tags: - App Connections description: Delete the specified GCP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GCP Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnection 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/app-connections/gcp/connection-name/{connectionName}: get: operationId: getGcpAppConnectionByName tags: - App Connections description: Get the specified GCP Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the GCP Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the GCP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnection 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/app-connections/gcp/{connectionId}/rotate-credentials: post: operationId: rotateGcpAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified GCP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GCP Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gcp method: type: string enum: - service-account-impersonation credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GCP (Service Account Impersonation) required: - appConnection 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/app-connections/azure-key-vault: get: operationId: listAzureKeyVaultAppConnections tags: - App Connections description: List the Azure Key Vault Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure Key Vault Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnections 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 post: operationId: createAzureKeyVaultAppConnection tags: - App Connections description: Create an Azure Key Vault Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with Azure Key Vault. credentials: type: object properties: code: type: string minLength: 1 tenantId: type: string required: - code additionalProperties: false description: The credentials used to connect with Azure Key Vault. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - client-secret description: The method used to authenticate with Azure Key Vault. credentials: type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 clientSecret: type: string minLength: 1 maxLength: 50 tenantId: type: string format: uuid minLength: 1 clientSecretKeyId: type: string format: uuid description: The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked. required: - clientId - clientSecret - tenantId additionalProperties: false description: The credentials used to connect with Azure Key Vault. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - certificate description: The method used to authenticate with Azure Key Vault. credentials: type: object properties: tenantId: type: string format: uuid minLength: 1 clientId: type: string format: uuid minLength: 1 certificateBody: type: string minLength: 1 privateKey: type: string minLength: 1 required: - tenantId - clientId - certificateBody - privateKey additionalProperties: false description: The credentials used to connect with Azure Key Vault. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure Key Vault Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure Key Vault Connection. projectId: type: string description: The ID of the project to create the Azure Key Vault Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure Key Vault Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean description: Whether or not automatic credential rotation is enabled for the Azure Key Vault Connection. rotation: type: object properties: rotationInterval: type: integer minimum: 1 maximum: 365 description: The interval in days between credential rotations. rotateAtUtc: type: object properties: hours: type: integer minimum: 0 maximum: 23 description: The hour (0-23) at which to rotate (UTC timezone). minutes: type: integer minimum: 0 maximum: 59 description: The minute (0-59) at which to rotate (UTC timezone). required: - hours - minutes additionalProperties: false required: - rotationInterval - rotateAtUtc additionalProperties: false description: The credential rotation configuration for the Azure Key Vault Connection. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnection 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/app-connections/azure-key-vault/available: get: operationId: listAzureKeyVaultAvailableAppConnections tags: - App Connections description: List the Azure Key Vault Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure Key Vault Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-key-vault/{connectionId}: get: operationId: getAzureKeyVaultAppConnection tags: - App Connections description: Get the specified Azure Key Vault Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Key Vault Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnection 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: updateAzureKeyVaultAppConnection tags: - App Connections description: Update the specified Azure Key Vault Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: code: type: string minLength: 1 tenantId: type: string required: - code additionalProperties: false - type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 clientSecret: type: string minLength: 1 maxLength: 50 tenantId: type: string format: uuid minLength: 1 clientSecretKeyId: type: string format: uuid description: The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked. required: - clientId - clientSecret - tenantId additionalProperties: false - type: object properties: tenantId: type: string format: uuid minLength: 1 clientId: type: string format: uuid minLength: 1 certificateBody: type: string minLength: 1 privateKey: type: string minLength: 1 required: - tenantId - clientId - certificateBody - privateKey additionalProperties: false description: The credentials used to connect with Azure Key Vault. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure Key Vault Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure Key Vault Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure Key Vault Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean description: Whether or not automatic credential rotation is enabled for the Azure Key Vault Connection. rotation: type: object properties: rotationInterval: type: integer minimum: 1 maximum: 365 description: The interval in days between credential rotations. rotateAtUtc: type: object properties: hours: type: integer minimum: 0 maximum: 23 description: The hour (0-23) at which to rotate (UTC timezone). minutes: type: integer minimum: 0 maximum: 59 description: The minute (0-59) at which to rotate (UTC timezone). required: - hours - minutes additionalProperties: false additionalProperties: false description: The updated credential rotation configuration for the Azure Key Vault Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Key Vault Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnection 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: deleteAzureKeyVaultAppConnection tags: - App Connections description: Delete the specified Azure Key Vault Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Key Vault Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnection 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/app-connections/azure-key-vault/connection-name/{connectionName}: get: operationId: getAzureKeyVaultAppConnectionByName tags: - App Connections description: Get the specified Azure Key Vault Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure Key Vault Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure Key Vault Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnection 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/app-connections/azure-key-vault/{connectionId}/rotate-credentials: post: operationId: rotateAzureKeyVaultAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure Key Vault Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Key Vault Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-key-vault method: type: string enum: - certificate credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Key Vault (Certificate) required: - appConnection 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/app-connections/azure-app-configuration: get: operationId: listAzureAppConfigurationAppConnections tags: - App Connections description: List the Azure App Configuration Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure App Configuration Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnections 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 post: operationId: createAzureAppConfigurationAppConnection tags: - App Connections description: Create an Azure App Configuration Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with Azure App Configuration. credentials: type: object properties: code: type: string minLength: 1 tenantId: type: string required: - code additionalProperties: false description: The credentials used to connect with Azure App Configuration. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - client-secret description: The method used to authenticate with Azure App Configuration. credentials: type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 clientSecret: type: string minLength: 1 maxLength: 50 tenantId: type: string format: uuid minLength: 1 required: - clientId - clientSecret - tenantId additionalProperties: false description: The credentials used to connect with Azure App Configuration. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure App Configuration Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure App Configuration Connection. projectId: type: string description: The ID of the project to create the Azure App Configuration Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure App Configuration Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure App Configuration Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure App Configuration Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure App Configuration Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure App Configuration Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnection 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/app-connections/azure-app-configuration/available: get: operationId: listAzureAppConfigurationAvailableAppConnections tags: - App Connections description: List the Azure App Configuration Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure App Configuration Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-app-configuration/{connectionId}: get: operationId: getAzureAppConfigurationAppConnection tags: - App Connections description: Get the specified Azure App Configuration Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure App Configuration Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnection 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: updateAzureAppConfigurationAppConnection tags: - App Connections description: Update the specified Azure App Configuration Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: code: type: string minLength: 1 tenantId: type: string required: - code additionalProperties: false - type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 clientSecret: type: string minLength: 1 maxLength: 50 tenantId: type: string format: uuid minLength: 1 required: - clientId - clientSecret - tenantId additionalProperties: false description: The credentials used to connect with Azure App Configuration. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure App Configuration Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure App Configuration Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure App Configuration Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure App Configuration Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure App Configuration Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure App Configuration Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure App Configuration Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure App Configuration Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnection 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: deleteAzureAppConfigurationAppConnection tags: - App Connections description: Delete the specified Azure App Configuration Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure App Configuration Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnection 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/app-connections/azure-app-configuration/connection-name/{connectionName}: get: operationId: getAzureAppConfigurationAppConnectionByName tags: - App Connections description: Get the specified Azure App Configuration Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure App Configuration Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure App Configuration Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnection 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/app-connections/azure-app-configuration/{connectionId}/rotate-credentials: post: operationId: rotateAzureAppConfigurationAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure App Configuration Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure App Configuration Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-app-configuration method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure App Configuration (Client Secret) required: - appConnection 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/app-connections/azure-client-secrets: get: operationId: listAzureClientSecretsAppConnections tags: - App Connections description: List the Azure Client Secrets Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure Client Secrets Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnections 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 post: operationId: createAzureClientSecretsAppConnection tags: - App Connections description: Create an Azure Client Secrets Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with Azure Client Secrets. credentials: type: object properties: code: type: string minLength: 1 description: The OAuth code to use to connect with Azure Client Secrets. tenantId: type: string minLength: 1 description: The Tenant ID to use to connect with Azure Client Secrets. required: - code - tenantId additionalProperties: false description: The credentials used to connect with Azure Client Secrets. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - client-secret description: The method used to authenticate with Azure Client Secrets. credentials: type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 description: The Client ID to use to connect with Azure Client Secrets. clientSecret: type: string minLength: 1 maxLength: 50 description: The Client Secret to use to connect with Azure Client Secrets. tenantId: type: string format: uuid minLength: 1 description: The Tenant ID to use to connect with Azure Client Secrets. clientSecretKeyId: type: string format: uuid description: The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked. required: - clientId - clientSecret - tenantId additionalProperties: false description: The credentials used to connect with Azure Client Secrets. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - certificate description: The method used to authenticate with Azure Client Secrets. credentials: type: object properties: tenantId: type: string format: uuid minLength: 1 description: The Tenant ID to use to connect with Azure Client Secrets. clientId: type: string format: uuid minLength: 1 description: The Client ID to use to connect with Azure Client Secrets. certificateBody: type: string minLength: 1 description: The certificate body in PEM format to use to connect with Azure Client Secrets. privateKey: type: string minLength: 1 description: The private key to use to connect with Azure Client Secrets. This is never transmitted to Azure and is only used to sign the Azure client assertion with. required: - tenantId - clientId - certificateBody - privateKey additionalProperties: false description: The credentials used to connect with Azure Client Secrets. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure Client Secrets Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure Client Secrets Connection. projectId: type: string description: The ID of the project to create the Azure Client Secrets Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure Client Secrets Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Client Secrets Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Client Secrets Connections. isAutoRotationEnabled: type: boolean description: Whether or not automatic credential rotation is enabled for the Azure Client Secrets Connection. rotation: type: object properties: rotationInterval: type: integer minimum: 1 maximum: 365 description: The interval in days between credential rotations. rotateAtUtc: type: object properties: hours: type: integer minimum: 0 maximum: 23 description: The hour (0-23) at which to rotate (UTC timezone). minutes: type: integer minimum: 0 maximum: 59 description: The minute (0-59) at which to rotate (UTC timezone). required: - hours - minutes additionalProperties: false required: - rotationInterval - rotateAtUtc additionalProperties: false description: The credential rotation configuration for the Azure Client Secrets Connection. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnection 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/app-connections/azure-client-secrets/available: get: operationId: listAzureClientSecretsAvailableAppConnections tags: - App Connections description: List the Azure Client Secrets Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure Client Secrets Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-client-secrets name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-client-secrets/{connectionId}: get: operationId: getAzureClientSecretsAppConnection tags: - App Connections description: Get the specified Azure Client Secrets Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Client Secrets Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnection 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: updateAzureClientSecretsAppConnection tags: - App Connections description: Update the specified Azure Client Secrets Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: code: type: string minLength: 1 description: The OAuth code to use to connect with Azure Client Secrets. tenantId: type: string minLength: 1 description: The Tenant ID to use to connect with Azure Client Secrets. required: - code - tenantId additionalProperties: false - type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 description: The Client ID to use to connect with Azure Client Secrets. clientSecret: type: string minLength: 1 maxLength: 50 description: The Client Secret to use to connect with Azure Client Secrets. tenantId: type: string format: uuid minLength: 1 description: The Tenant ID to use to connect with Azure Client Secrets. clientSecretKeyId: type: string format: uuid description: The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked. required: - clientId - clientSecret - tenantId additionalProperties: false - type: object properties: tenantId: type: string format: uuid minLength: 1 description: The Tenant ID to use to connect with Azure Client Secrets. clientId: type: string format: uuid minLength: 1 description: The Client ID to use to connect with Azure Client Secrets. certificateBody: type: string minLength: 1 description: The certificate body in PEM format to use to connect with Azure Client Secrets. privateKey: type: string minLength: 1 description: The private key to use to connect with Azure Client Secrets. This is never transmitted to Azure and is only used to sign the Azure client assertion with. required: - tenantId - clientId - certificateBody - privateKey additionalProperties: false description: The credentials used to connect with Azure Client Secrets. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure Client Secrets Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure Client Secrets Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure Client Secrets Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Client Secrets Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Client Secrets Connections. isAutoRotationEnabled: type: boolean description: Whether or not automatic credential rotation is enabled for the Azure Client Secrets Connection. rotation: type: object properties: rotationInterval: type: integer minimum: 1 maximum: 365 description: The interval in days between credential rotations. rotateAtUtc: type: object properties: hours: type: integer minimum: 0 maximum: 23 description: The hour (0-23) at which to rotate (UTC timezone). minutes: type: integer minimum: 0 maximum: 59 description: The minute (0-59) at which to rotate (UTC timezone). required: - hours - minutes additionalProperties: false additionalProperties: false description: The updated credential rotation configuration for the Azure Client Secrets Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Client Secrets Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnection 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: deleteAzureClientSecretsAppConnection tags: - App Connections description: Delete the specified Azure Client Secrets Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Client Secrets Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnection 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/app-connections/azure-client-secrets/connection-name/{connectionName}: get: operationId: getAzureClientSecretsAppConnectionByName tags: - App Connections description: Get the specified Azure Client Secrets Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure Client Secrets Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure Client Secrets Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnection 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/app-connections/azure-client-secrets/{connectionId}/rotate-credentials: post: operationId: rotateAzureClientSecretsAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure Client Secrets Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Client Secrets Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string required: - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Client Secret) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-client-secrets method: type: string enum: - certificate credentials: type: object properties: tenantId: type: string clientId: type: string required: - tenantId - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Client Secrets (Certificate) required: - appConnection 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/app-connections/azure-devops: get: operationId: listAzureDevopsAppConnections tags: - App Connections description: List the Azure DevOps Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure DevOps Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnections 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 post: operationId: createAzureDevopsAppConnection tags: - App Connections description: Create an Azure DevOps Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with Azure DevOps. credentials: type: object properties: code: type: string minLength: 1 description: The OAuth code to use to connect with Azure DevOps. tenantId: type: string minLength: 1 description: The Tenant ID to use to connect with Azure DevOps. orgName: type: string minLength: 1 description: The Organization name to use to connect with Azure DevOps. required: - code - tenantId - orgName additionalProperties: false description: The credentials used to connect with Azure DevOps. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with Azure DevOps. credentials: type: object properties: accessToken: type: string minLength: 1 orgName: type: string minLength: 1 required: - accessToken - orgName additionalProperties: false description: The credentials used to connect with Azure DevOps. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - client-secret description: The method used to authenticate with Azure DevOps. credentials: type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 description: The Client ID to use to connect with Azure Client Secrets. clientSecret: type: string minLength: 1 maxLength: 50 description: The Client Secret to use to connect with Azure Client Secrets. tenantId: type: string format: uuid minLength: 1 description: The Tenant ID to use to connect with Azure DevOps. orgName: type: string minLength: 1 description: The Organization name to use to connect with Azure DevOps. required: - clientId - clientSecret - tenantId - orgName additionalProperties: false description: The credentials used to connect with Azure DevOps. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure DevOps Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure DevOps Connection. projectId: type: string description: The ID of the project to create the Azure DevOps Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure DevOps Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DevOps Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DevOps Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure DevOps Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DevOps Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnection 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/app-connections/azure-devops/available: get: operationId: listAzureDevopsAvailableAppConnections tags: - App Connections description: List the Azure DevOps Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure DevOps Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-devops/{connectionId}: get: operationId: getAzureDevopsAppConnection tags: - App Connections description: Get the specified Azure DevOps Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DevOps Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnection 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: updateAzureDevopsAppConnection tags: - App Connections description: Update the specified Azure DevOps Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: code: type: string minLength: 1 description: The OAuth code to use to connect with Azure DevOps. tenantId: type: string minLength: 1 description: The Tenant ID to use to connect with Azure DevOps. orgName: type: string minLength: 1 description: The Organization name to use to connect with Azure DevOps. required: - code - tenantId - orgName additionalProperties: false - type: object properties: accessToken: type: string minLength: 1 orgName: type: string minLength: 1 required: - accessToken - orgName additionalProperties: false - type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 description: The Client ID to use to connect with Azure Client Secrets. clientSecret: type: string minLength: 1 maxLength: 50 description: The Client Secret to use to connect with Azure Client Secrets. tenantId: type: string format: uuid minLength: 1 description: The Tenant ID to use to connect with Azure DevOps. orgName: type: string minLength: 1 description: The Organization name to use to connect with Azure DevOps. required: - clientId - clientSecret - tenantId - orgName additionalProperties: false description: The credentials used to connect with Azure DevOps. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure DevOps Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure DevOps Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure DevOps Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DevOps Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DevOps Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure DevOps Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DevOps Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DevOps Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnection 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: deleteAzureDevopsAppConnection tags: - App Connections description: Delete the specified Azure DevOps Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DevOps Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnection 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/app-connections/azure-devops/connection-name/{connectionName}: get: operationId: getAzureDevopsAppConnectionByName tags: - App Connections description: Get the specified Azure DevOps Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure DevOps Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure DevOps Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnection 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/app-connections/azure-devops/{connectionId}/rotate-credentials: post: operationId: rotateAzureDevopsAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure DevOps Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DevOps Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - oauth credentials: type: object properties: tenantId: type: string orgName: type: string required: - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (OAuth) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - access-token credentials: type: object properties: orgName: type: string required: - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-devops method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string orgName: type: string required: - clientId - tenantId - orgName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DevOps (Client Secret) required: - appConnection 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/app-connections/azure-adcs: get: operationId: listAzureAdcsAppConnections tags: - App Connections description: List the Azure ADCS Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure ADCS Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnections 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 post: operationId: createAzureAdcsAppConnection tags: - App Connections description: Create an Azure ADCS Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-password description: The method used to authenticate with Azure ADCS. credentials: type: object properties: adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' password: type: string minLength: 1 maxLength: 255 description: The password used to access Azure ADCS. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - adcsUrl - username - password additionalProperties: false description: The credentials used to connect with Azure ADCS. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure ADCS Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure ADCS Connection. projectId: type: string description: The ID of the project to create the Azure ADCS Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure ADCS Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure ADCS Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure ADCS Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure ADCS Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure ADCS Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnection 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/app-connections/azure-adcs/available: get: operationId: listAzureAdcsAvailableAppConnections tags: - App Connections description: List the Azure ADCS Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure ADCS Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-adcs name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-adcs/{connectionId}: get: operationId: getAzureAdcsAppConnection tags: - App Connections description: Get the specified Azure ADCS Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure ADCS Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnection 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: updateAzureAdcsAppConnection tags: - App Connections description: Update the specified Azure ADCS Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' password: type: string minLength: 1 maxLength: 255 description: The password used to access Azure ADCS. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - adcsUrl - username - password additionalProperties: false description: The credentials used to connect with Azure ADCS. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure ADCS Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure ADCS Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure ADCS Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure ADCS Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure ADCS Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure ADCS Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure ADCS Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure ADCS Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnection 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: deleteAzureAdcsAppConnection tags: - App Connections description: Delete the specified Azure ADCS Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure ADCS Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnection 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/app-connections/azure-adcs/connection-name/{connectionName}: get: operationId: getAzureAdcsAppConnectionByName tags: - App Connections description: Get the specified Azure ADCS Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure ADCS Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure ADCS Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnection 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/app-connections/azure-adcs/{connectionId}/rotate-credentials: post: operationId: rotateAzureAdcsAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure ADCS Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure ADCS Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-adcs method: type: string enum: - username-password credentials: type: object properties: username: type: string minLength: 1 maxLength: 255 description: 'The username used to access Azure ADCS (format: ''DOMAIN\username'' or ''username@domain.com'').' adcsUrl: type: string minLength: 1 maxLength: 255 description: The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection. required: - username - adcsUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure ADCS (Username and Password) required: - appConnection 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/app-connections/azure-dns: get: operationId: listAzureDnsAppConnections tags: - App Connections description: List the Azure DNS Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure DNS Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnections 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 post: operationId: createAzureDnsAppConnection tags: - App Connections description: Create an Azure DNS Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - client-secret description: The method used to authenticate with Azure DNS. credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID clientId: type: string description: Client ID must be a valid GUID clientSecret: type: string minLength: 1 maxLength: 256 subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - clientId - clientSecret - subscriptionId additionalProperties: false description: The credentials used to connect with Azure DNS. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure DNS Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure DNS Connection. projectId: type: string description: The ID of the project to create the Azure DNS Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure DNS Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DNS Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DNS Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure DNS Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DNS Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnection 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/app-connections/azure-dns/available: get: operationId: listAzureDnsAvailableAppConnections tags: - App Connections description: List the Azure DNS Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure DNS Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-dns name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-dns/{connectionId}: get: operationId: getAzureDnsAppConnection tags: - App Connections description: Get the specified Azure DNS Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DNS Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnection 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: updateAzureDnsAppConnection tags: - App Connections description: Update the specified Azure DNS Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID clientId: type: string description: Client ID must be a valid GUID clientSecret: type: string minLength: 1 maxLength: 256 subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - clientId - clientSecret - subscriptionId additionalProperties: false description: The credentials used to connect with Azure DNS. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure DNS Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure DNS Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure DNS Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DNS Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DNS Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure DNS Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure DNS Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DNS Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnection 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: deleteAzureDnsAppConnection tags: - App Connections description: Delete the specified Azure DNS Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DNS Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnection 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/app-connections/azure-dns/connection-name/{connectionName}: get: operationId: getAzureDnsAppConnectionByName tags: - App Connections description: Get the specified Azure DNS Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure DNS Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure DNS Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnection 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/app-connections/azure-dns/{connectionId}/rotate-credentials: post: operationId: rotateAzureDnsAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure DNS Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure DNS Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-dns method: type: string enum: - client-secret credentials: type: object properties: tenantId: type: string description: Tenant ID must be a valid GUID subscriptionId: type: string description: Subscription ID must be a valid GUID required: - tenantId - subscriptionId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure DNS (Client Secret) required: - appConnection 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/app-connections/databricks: get: operationId: listDatabricksAppConnections tags: - App Connections description: List the Databricks Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Databricks Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnections 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 post: operationId: createDatabricksAppConnection tags: - App Connections description: Create a Databricks Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - service-principal description: The method used to authenticate with Databricks. credentials: type: object properties: clientId: type: string minLength: 1 clientSecret: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - clientSecret - workspaceUrl additionalProperties: false description: The credentials used to connect with Databricks. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Databricks Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Databricks Connection. projectId: type: string description: The ID of the project to create the Databricks Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Databricks Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Databricks Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Databricks Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Databricks Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Databricks Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnection 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/app-connections/databricks/available: get: operationId: listDatabricksAvailableAppConnections tags: - App Connections description: List the Databricks Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Databricks Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/databricks/{connectionId}: get: operationId: getDatabricksAppConnection tags: - App Connections description: Get the specified Databricks Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Databricks Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnection 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: updateDatabricksAppConnection tags: - App Connections description: Update the specified Databricks Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: clientId: type: string minLength: 1 clientSecret: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - clientSecret - workspaceUrl additionalProperties: false description: The credentials used to connect with Databricks. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Databricks Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Databricks Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Databricks Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Databricks Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Databricks Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Databricks Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Databricks Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Databricks Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnection 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: deleteDatabricksAppConnection tags: - App Connections description: Delete the specified Databricks Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Databricks Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnection 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/app-connections/databricks/connection-name/{connectionName}: get: operationId: getDatabricksAppConnectionByName tags: - App Connections description: Get the specified Databricks Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Databricks Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Databricks Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnection 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/app-connections/databricks/{connectionId}/rotate-credentials: post: operationId: rotateDatabricksAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Databricks Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Databricks Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - databricks method: type: string enum: - service-principal credentials: type: object properties: clientId: type: string minLength: 1 workspaceUrl: type: string format: uri minLength: 1 required: - clientId - workspaceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Databricks (Service Principal) required: - appConnection 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/app-connections/humanitec: get: operationId: listHumanitecAppConnections tags: - App Connections description: List the Humanitec Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Humanitec Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnections 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 post: operationId: createHumanitecAppConnection tags: - App Connections description: Create a Humanitec Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Humanitec. credentials: type: object properties: apiToken: type: string minLength: 1 required: - apiToken additionalProperties: false description: The credentials used to connect with Humanitec. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Humanitec Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Humanitec Connection. projectId: type: string description: The ID of the project to create the Humanitec Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Humanitec Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Humanitec Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Humanitec Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Humanitec Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Humanitec Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnection 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/app-connections/humanitec/available: get: operationId: listHumanitecAvailableAppConnections tags: - App Connections description: List the Humanitec Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Humanitec Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/humanitec/{connectionId}: get: operationId: getHumanitecAppConnection tags: - App Connections description: Get the specified Humanitec Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Humanitec Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnection 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: updateHumanitecAppConnection tags: - App Connections description: Update the specified Humanitec Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 required: - apiToken additionalProperties: false description: The credentials used to connect with Humanitec. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Humanitec Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Humanitec Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Humanitec Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Humanitec Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Humanitec Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Humanitec Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Humanitec Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Humanitec Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnection 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: deleteHumanitecAppConnection tags: - App Connections description: Delete the specified Humanitec Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Humanitec Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnection 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/app-connections/humanitec/connection-name/{connectionName}: get: operationId: getHumanitecAppConnectionByName tags: - App Connections description: Get the specified Humanitec Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Humanitec Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Humanitec Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnection 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/app-connections/humanitec/{connectionId}/rotate-credentials: post: operationId: rotateHumanitecAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Humanitec Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Humanitec Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - humanitec method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Humanitec (API Token) required: - appConnection 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/app-connections/terraform-cloud: get: operationId: listTerraformCloudAppConnections tags: - App Connections description: List the Terraform Cloud Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Terraform Cloud Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnections 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 post: operationId: createTerraformCloudAppConnection tags: - App Connections description: Create a Terraform Cloud Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Terraform Cloud. credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token to use to connect with Terraform Cloud. required: - apiToken additionalProperties: false description: The credentials used to connect with Terraform Cloud. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Terraform Cloud Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Terraform Cloud Connection. projectId: type: string description: The ID of the project to create the Terraform Cloud Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Terraform Cloud Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Terraform Cloud Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Terraform Cloud Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Terraform Cloud Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Terraform Cloud Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnection 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/app-connections/terraform-cloud/available: get: operationId: listTerraformCloudAvailableAppConnections tags: - App Connections description: List the Terraform Cloud Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Terraform Cloud Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/terraform-cloud/{connectionId}: get: operationId: getTerraformCloudAppConnection tags: - App Connections description: Get the specified Terraform Cloud Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Terraform Cloud Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnection 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: updateTerraformCloudAppConnection tags: - App Connections description: Update the specified Terraform Cloud Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token to use to connect with Terraform Cloud. required: - apiToken additionalProperties: false description: The credentials used to connect with Terraform Cloud. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Terraform Cloud Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Terraform Cloud Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Terraform Cloud Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Terraform Cloud Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Terraform Cloud Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Terraform Cloud Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Terraform Cloud Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Terraform Cloud Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnection 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: deleteTerraformCloudAppConnection tags: - App Connections description: Delete the specified Terraform Cloud Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Terraform Cloud Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnection 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/app-connections/terraform-cloud/connection-name/{connectionName}: get: operationId: getTerraformCloudAppConnectionByName tags: - App Connections description: Get the specified Terraform Cloud Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Terraform Cloud Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Terraform Cloud Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnection 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/app-connections/terraform-cloud/{connectionId}/rotate-credentials: post: operationId: rotateTerraformCloudAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Terraform Cloud Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Terraform Cloud Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - terraform-cloud method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Terraform Cloud (API Token) required: - appConnection 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/app-connections/vercel: get: operationId: listVercelAppConnections tags: - App Connections description: List the Vercel Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Vercel Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnections 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 post: operationId: createVercelAppConnection tags: - App Connections description: Create a Vercel Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Vercel. credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Vercel. required: - apiToken additionalProperties: false description: The credentials used to connect with Vercel. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Vercel Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Vercel Connection. projectId: type: string description: The ID of the project to create the Vercel Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Vercel Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Vercel Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Vercel Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Vercel Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Vercel Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnection 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/app-connections/vercel/available: get: operationId: listVercelAvailableAppConnections tags: - App Connections description: List the Vercel Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Vercel Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/vercel/{connectionId}: get: operationId: getVercelAppConnection tags: - App Connections description: Get the specified Vercel Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Vercel Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnection 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: updateVercelAppConnection tags: - App Connections description: Update the specified Vercel Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Vercel. required: - apiToken additionalProperties: false description: The credentials used to connect with Vercel. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Vercel Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Vercel Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Vercel Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Vercel Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Vercel Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Vercel Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Vercel Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Vercel Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnection 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: deleteVercelAppConnection tags: - App Connections description: Delete the specified Vercel Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Vercel Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnection 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/app-connections/vercel/connection-name/{connectionName}: get: operationId: getVercelAppConnectionByName tags: - App Connections description: Get the specified Vercel Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Vercel Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Vercel Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnection 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/app-connections/vercel/{connectionId}/rotate-credentials: post: operationId: rotateVercelAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Vercel Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Vercel Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - vercel method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Vercel (API Token) required: - appConnection 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/app-connections/postgres: get: operationId: listPostgresAppConnections tags: - App Connections description: List the PostgreSQL Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list PostgreSQL Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnections 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 post: operationId: createPostgresAppConnection tags: - App Connections description: Create a PostgreSQL Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-password description: The method used to authenticate with PostgreSQL. credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with PostgreSQL. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the PostgreSQL Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the PostgreSQL Connection. projectId: type: string description: The ID of the project to create the PostgreSQL Connection in. isPlatformManagedCredentials: type: boolean default: false description: Whether or not the PostgreSQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for PostgreSQL Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for PostgreSQL Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnection 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/app-connections/postgres/available: get: operationId: listPostgresAvailableAppConnections tags: - App Connections description: List the PostgreSQL Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list PostgreSQL Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - postgres name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/postgres/{connectionId}: get: operationId: getPostgresAppConnection tags: - App Connections description: Get the specified PostgreSQL Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the PostgreSQL Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnection 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: updatePostgresAppConnection tags: - App Connections description: Update the specified PostgreSQL Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with PostgreSQL. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the PostgreSQL Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the PostgreSQL Connection. isPlatformManagedCredentials: type: boolean description: Whether or not the PostgreSQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for PostgreSQL Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for PostgreSQL Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the PostgreSQL Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnection 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: deletePostgresAppConnection tags: - App Connections description: Delete the specified PostgreSQL Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the PostgreSQL Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnection 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/app-connections/postgres/connection-name/{connectionName}: get: operationId: getPostgresAppConnectionByName tags: - App Connections description: Get the specified PostgreSQL Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the PostgreSQL Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the PostgreSQL Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnection 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/app-connections/postgres/{connectionId}/rotate-credentials: post: operationId: rotatePostgresAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified PostgreSQL Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the PostgreSQL Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - postgres method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: PostgreSQL (Username and Password) required: - appConnection 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/app-connections/mssql: get: operationId: listMsSqlAppConnections tags: - App Connections description: List the Microsoft SQL Server Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Microsoft SQL Server Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnections 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 post: operationId: createMsSqlAppConnection tags: - App Connections description: Create a Microsoft SQL Server Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-password description: The method used to authenticate with Microsoft SQL Server. credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with Microsoft SQL Server. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Microsoft SQL Server Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Microsoft SQL Server Connection. projectId: type: string description: The ID of the project to create the Microsoft SQL Server Connection in. isPlatformManagedCredentials: type: boolean default: false description: Whether or not the Microsoft SQL Server Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Microsoft SQL Server Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Microsoft SQL Server Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnection 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/app-connections/mssql/available: get: operationId: listMsSqlAvailableAppConnections tags: - App Connections description: List the Microsoft SQL Server Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Microsoft SQL Server Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - mssql name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/mssql/{connectionId}: get: operationId: getMsSqlAppConnection tags: - App Connections description: Get the specified Microsoft SQL Server Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Microsoft SQL Server Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnection 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: updateMsSqlAppConnection tags: - App Connections description: Update the specified Microsoft SQL Server Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with Microsoft SQL Server. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Microsoft SQL Server Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Microsoft SQL Server Connection. isPlatformManagedCredentials: type: boolean description: Whether or not the Microsoft SQL Server Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Microsoft SQL Server Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Microsoft SQL Server Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Microsoft SQL Server Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnection 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: deleteMsSqlAppConnection tags: - App Connections description: Delete the specified Microsoft SQL Server Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Microsoft SQL Server Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnection 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/app-connections/mssql/connection-name/{connectionName}: get: operationId: getMsSqlAppConnectionByName tags: - App Connections description: Get the specified Microsoft SQL Server Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Microsoft SQL Server Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Microsoft SQL Server Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnection 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/app-connections/mssql/{connectionId}/rotate-credentials: post: operationId: rotateMsSqlAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Microsoft SQL Server Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Microsoft SQL Server Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mssql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Microsoft SQL Server (Username and Password) required: - appConnection 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/app-connections/mysql: get: operationId: listMySqlAppConnections tags: - App Connections description: List the MySQL Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list MySQL Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnections 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 post: operationId: createMySqlAppConnection tags: - App Connections description: Create a MySQL Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-password description: The method used to authenticate with MySQL. credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with MySQL. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the MySQL Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the MySQL Connection. projectId: type: string description: The ID of the project to create the MySQL Connection in. isPlatformManagedCredentials: type: boolean default: false description: Whether or not the MySQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for MySQL Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MySQL Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnection 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/app-connections/mysql/available: get: operationId: listMySqlAvailableAppConnections tags: - App Connections description: List the MySQL Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list MySQL Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - mysql name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/mysql/{connectionId}: get: operationId: getMySqlAppConnection tags: - App Connections description: Get the specified MySQL Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MySQL Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnection 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: updateMySqlAppConnection tags: - App Connections description: Update the specified MySQL Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with MySQL. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the MySQL Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the MySQL Connection. isPlatformManagedCredentials: type: boolean description: Whether or not the MySQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for MySQL Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MySQL Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MySQL Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnection 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: deleteMySqlAppConnection tags: - App Connections description: Delete the specified MySQL Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MySQL Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnection 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/app-connections/mysql/connection-name/{connectionName}: get: operationId: getMySqlAppConnectionByName tags: - App Connections description: Get the specified MySQL Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the MySQL Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the MySQL Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnection 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/app-connections/mysql/{connectionId}/rotate-credentials: post: operationId: rotateMySqlAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified MySQL Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MySQL Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mysql method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: MySQL (Username and Password) required: - appConnection 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/app-connections/camunda: get: operationId: listCamundaAppConnections tags: - App Connections description: List the Camunda Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Camunda Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnections 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 post: operationId: createCamundaAppConnection tags: - App Connections description: Create a Camunda Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - client-credentials description: The method used to authenticate with Camunda. credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. clientSecret: type: string minLength: 1 description: The client secret used to authenticate with Camunda. required: - clientId - clientSecret additionalProperties: false description: The credentials used to connect with Camunda. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Camunda Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Camunda Connection. projectId: type: string description: The ID of the project to create the Camunda Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Camunda Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Camunda Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Camunda Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Camunda Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Camunda Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnection 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/app-connections/camunda/available: get: operationId: listCamundaAvailableAppConnections tags: - App Connections description: List the Camunda Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Camunda Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/camunda/{connectionId}: get: operationId: getCamundaAppConnection tags: - App Connections description: Get the specified Camunda Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Camunda Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnection 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: updateCamundaAppConnection tags: - App Connections description: Update the specified Camunda Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. clientSecret: type: string minLength: 1 description: The client secret used to authenticate with Camunda. required: - clientId - clientSecret additionalProperties: false description: The credentials used to connect with Camunda. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Camunda Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Camunda Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Camunda Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Camunda Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Camunda Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Camunda Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Camunda Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Camunda Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnection 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: deleteCamundaAppConnection tags: - App Connections description: Delete the specified Camunda Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Camunda Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnection 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/app-connections/camunda/connection-name/{connectionName}: get: operationId: getCamundaAppConnectionByName tags: - App Connections description: Get the specified Camunda Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Camunda Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Camunda Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnection 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/app-connections/camunda/{connectionId}/rotate-credentials: post: operationId: rotateCamundaAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Camunda Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Camunda Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - camunda method: type: string enum: - client-credentials credentials: type: object properties: clientId: type: string minLength: 1 description: The client ID used to authenticate with Camunda. required: - clientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Camunda (Client Credentials) required: - appConnection 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/app-connections/windmill: get: operationId: listWindmillAppConnections tags: - App Connections description: List the Windmill Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Windmill Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnections 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 post: operationId: createWindmillAppConnection tags: - App Connections description: Create a Windmill Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with Windmill. credentials: type: object properties: accessToken: type: string minLength: 1 description: The access token to use to connect with Windmill. instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). required: - accessToken additionalProperties: false description: The credentials used to connect with Windmill. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Windmill Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Windmill Connection. projectId: type: string description: The ID of the project to create the Windmill Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Windmill Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Windmill Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Windmill Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Windmill Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Windmill Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnection 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/app-connections/windmill/available: get: operationId: listWindmillAvailableAppConnections tags: - App Connections description: List the Windmill Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Windmill Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/windmill/{connectionId}: get: operationId: getWindmillAppConnection tags: - App Connections description: Get the specified Windmill Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Windmill Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnection 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: updateWindmillAppConnection tags: - App Connections description: Update the specified Windmill Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accessToken: type: string minLength: 1 description: The access token to use to connect with Windmill. instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). required: - accessToken additionalProperties: false description: The credentials used to connect with Windmill. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Windmill Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Windmill Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Windmill Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Windmill Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Windmill Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Windmill Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Windmill Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Windmill Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnection 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: deleteWindmillAppConnection tags: - App Connections description: Delete the specified Windmill Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Windmill Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnection 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/app-connections/windmill/connection-name/{connectionName}: get: operationId: getWindmillAppConnectionByName tags: - App Connections description: Get the specified Windmill Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Windmill Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Windmill Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnection 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/app-connections/windmill/{connectionId}/rotate-credentials: post: operationId: rotateWindmillAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Windmill Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Windmill Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - windmill method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Windmill instance URL to connect with (defaults to https://app.windmill.dev). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Windmill (Access Token) required: - appConnection 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/app-connections/auth0: get: operationId: listAuth0AppConnections tags: - App Connections description: List the Auth0 Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Auth0 Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnections 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 post: operationId: createAuth0AppConnection tags: - App Connections description: Create an Auth0 Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - client-credentials description: The method used to authenticate with Auth0. credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. clientSecret: type: string minLength: 1 description: Your Auth0 application's Client Secret. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - clientSecret - audience additionalProperties: false description: The credentials used to connect with Auth0. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Auth0 Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Auth0 Connection. projectId: type: string description: The ID of the project to create the Auth0 Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Auth0 Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Auth0 Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Auth0 Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Auth0 Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Auth0 Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnection 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/app-connections/auth0/available: get: operationId: listAuth0AvailableAppConnections tags: - App Connections description: List the Auth0 Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Auth0 Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - auth0 name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/auth0/{connectionId}: get: operationId: getAuth0AppConnection tags: - App Connections description: Get the specified Auth0 Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Auth0 Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnection 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: updateAuth0AppConnection tags: - App Connections description: Update the specified Auth0 Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. clientSecret: type: string minLength: 1 description: Your Auth0 application's Client Secret. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - clientSecret - audience additionalProperties: false description: The credentials used to connect with Auth0. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Auth0 Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Auth0 Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Auth0 Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Auth0 Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Auth0 Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Auth0 Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Auth0 Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Auth0 Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnection 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: deleteAuth0AppConnection tags: - App Connections description: Delete the specified Auth0 Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Auth0 Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnection 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/app-connections/auth0/connection-name/{connectionName}: get: operationId: getAuth0AppConnectionByName tags: - App Connections description: Get the specified Auth0 Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Auth0 Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Auth0 Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnection 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/app-connections/auth0/{connectionId}/rotate-credentials: post: operationId: rotateAuth0AppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Auth0 Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Auth0 Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - auth0 method: type: string enum: - client-credentials credentials: type: object properties: domain: type: string minLength: 1 description: The domain of the Auth0 instance to connect to. clientId: type: string minLength: 1 description: Your Auth0 application's Client ID. audience: type: string format: uri minLength: 1 description: The unique identifier of the target API you want to access. required: - domain - clientId - audience additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Auth0 (Client Credentials) required: - appConnection 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/app-connections/hashicorp-vault: get: operationId: listHashicorpVaultAppConnections tags: - App Connections description: List the Hashicorp Vault Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Hashicorp Vault Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnections 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 post: operationId: createHashicorpVaultAppConnection tags: - App Connections description: Create a Hashicorp Vault Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with Hashicorp Vault. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. namespace: type: string description: The Hashicrop Vault namespace to connect with. accessToken: type: string minLength: 1 description: The access token used to connect with Hashicorp Vault. required: - instanceUrl - accessToken additionalProperties: false description: The credentials used to connect with Hashicorp Vault. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - app-role description: The method used to authenticate with Hashicorp Vault. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. namespace: type: string description: The Hashicrop Vault namespace to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. secretId: type: string minLength: 1 description: The Secret ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId - secretId additionalProperties: false description: The credentials used to connect with Hashicorp Vault. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Hashicorp Vault Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Hashicorp Vault Connection. projectId: type: string description: The ID of the project to create the Hashicorp Vault Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Hashicorp Vault Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Hashicorp Vault Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Hashicorp Vault Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnection 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/app-connections/hashicorp-vault/available: get: operationId: listHashicorpVaultAvailableAppConnections tags: - App Connections description: List the Hashicorp Vault Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Hashicorp Vault Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/hashicorp-vault/{connectionId}: get: operationId: getHashicorpVaultAppConnection tags: - App Connections description: Get the specified Hashicorp Vault Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Hashicorp Vault Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnection 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: updateHashicorpVaultAppConnection tags: - App Connections description: Update the specified Hashicorp Vault Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. namespace: type: string description: The Hashicrop Vault namespace to connect with. accessToken: type: string minLength: 1 description: The access token used to connect with Hashicorp Vault. required: - instanceUrl - accessToken additionalProperties: false - type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. namespace: type: string description: The Hashicrop Vault namespace to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. secretId: type: string minLength: 1 description: The Secret ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId - secretId additionalProperties: false description: The credentials used to connect with Hashicorp Vault. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Hashicorp Vault Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Hashicorp Vault Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Hashicorp Vault Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Hashicorp Vault Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Hashicorp Vault Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Hashicorp Vault Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnection 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: deleteHashicorpVaultAppConnection tags: - App Connections description: Delete the specified Hashicorp Vault Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Hashicorp Vault Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnection 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/app-connections/hashicorp-vault/connection-name/{connectionName}: get: operationId: getHashicorpVaultAppConnectionByName tags: - App Connections description: Get the specified Hashicorp Vault Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Hashicorp Vault Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Hashicorp Vault Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnection 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/app-connections/hashicorp-vault/{connectionId}/rotate-credentials: post: operationId: rotateHashicorpVaultAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Hashicorp Vault Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Hashicorp Vault Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - access-token credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - hashicorp-vault method: type: string enum: - app-role credentials: type: object properties: namespace: type: string description: The Hashicrop Vault namespace to connect with. instanceUrl: type: string minLength: 1 format: uri description: The Hashicrop Vault instance URL to connect with. roleId: type: string minLength: 1 description: The Role ID used to connect with Hashicorp Vault. required: - instanceUrl - roleId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Hashicorp Vault (App Role) required: - appConnection 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/app-connections/ldap: get: operationId: listLdapAppConnections tags: - App Connections description: List the LDAP Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list LDAP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnections 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 post: operationId: createLdapAppConnection tags: - App Connections description: Create a LDAP Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - simple-bind description: The method used to authenticate with LDAP. credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). password: type: string minLength: 1 description: The password to bind with for authentication. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn - password additionalProperties: false description: The credentials used to connect with LDAP. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the LDAP Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the LDAP Connection. projectId: type: string description: The ID of the project to create the LDAP Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for LDAP Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for LDAP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for LDAP Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnection 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/app-connections/ldap/available: get: operationId: listLdapAvailableAppConnections tags: - App Connections description: List the LDAP Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list LDAP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - ldap name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/ldap/{connectionId}: get: operationId: getLdapAppConnection tags: - App Connections description: Get the specified LDAP Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the LDAP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnection 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: updateLdapAppConnection tags: - App Connections description: Update the specified LDAP Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). password: type: string minLength: 1 description: The password to bind with for authentication. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn - password additionalProperties: false description: The credentials used to connect with LDAP. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the LDAP Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the LDAP Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for LDAP Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for LDAP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for LDAP Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the LDAP Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnection 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: deleteLdapAppConnection tags: - App Connections description: Delete the specified LDAP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the LDAP Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnection 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/app-connections/ldap/connection-name/{connectionName}: get: operationId: getLdapAppConnectionByName tags: - App Connections description: Get the specified LDAP Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the LDAP Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the LDAP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnection 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/app-connections/ldap/{connectionId}/rotate-credentials: post: operationId: rotateLdapAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified LDAP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the LDAP Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ldap method: type: string enum: - simple-bind credentials: type: object properties: provider: type: string enum: - active-directory description: The type of LDAP provider. Determines provider-specific behaviors. url: type: string minLength: 1 description: The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636'). dn: type: string minLength: 1 description: The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com'). sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments. sslCertificate: type: string description: The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate. required: - provider - url - dn additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: LDAP (Simple Bind) required: - appConnection 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/app-connections/teamcity: get: operationId: listTeamcityAppConnections tags: - App Connections description: List the TeamCity Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list TeamCity Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnections 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 post: operationId: createTeamcityAppConnection tags: - App Connections description: Create a TeamCity Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with TeamCity. credentials: type: object properties: accessToken: type: string minLength: 1 description: The access token to use to connect with TeamCity. instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - accessToken - instanceUrl additionalProperties: false description: The credentials used to connect with TeamCity. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the TeamCity Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the TeamCity Connection. projectId: type: string description: The ID of the project to create the TeamCity Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for TeamCity Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for TeamCity Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for TeamCity Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for TeamCity Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for TeamCity Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnection 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/app-connections/teamcity/available: get: operationId: listTeamcityAvailableAppConnections tags: - App Connections description: List the TeamCity Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list TeamCity Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/teamcity/{connectionId}: get: operationId: getTeamcityAppConnection tags: - App Connections description: Get the specified TeamCity Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the TeamCity Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnection 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: updateTeamcityAppConnection tags: - App Connections description: Update the specified TeamCity Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accessToken: type: string minLength: 1 description: The access token to use to connect with TeamCity. instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - accessToken - instanceUrl additionalProperties: false description: The credentials used to connect with TeamCity. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the TeamCity Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the TeamCity Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for TeamCity Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for TeamCity Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for TeamCity Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for TeamCity Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for TeamCity Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the TeamCity Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnection 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: deleteTeamcityAppConnection tags: - App Connections description: Delete the specified TeamCity Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the TeamCity Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnection 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/app-connections/teamcity/connection-name/{connectionName}: get: operationId: getTeamcityAppConnectionByName tags: - App Connections description: Get the specified TeamCity Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the TeamCity Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the TeamCity Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnection 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/app-connections/teamcity/{connectionId}/rotate-credentials: post: operationId: rotateTeamcityAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified TeamCity Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the TeamCity Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - teamcity method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The TeamCity instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: TeamCity (Access Token) required: - appConnection 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/app-connections/oci: get: operationId: listOciAppConnections tags: - App Connections description: List the OCI Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OCI Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnections 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 post: operationId: createOciAppConnection tags: - App Connections description: Create an OCI Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-key description: The method used to authenticate with OCI. credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. privateKey: type: string minLength: 1 description: The private key content in PEM format used to sign API requests. required: - userOcid - tenancyOcid - region - fingerprint - privateKey additionalProperties: false description: The credentials used to connect with OCI. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the OCI Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the OCI Connection. projectId: type: string description: The ID of the project to create the OCI Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for OCI Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OCI Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OCI Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OCI Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OCI Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnection 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/app-connections/oci/available: get: operationId: listOciAvailableAppConnections tags: - App Connections description: List the OCI Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OCI Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/oci/{connectionId}: get: operationId: getOciAppConnection tags: - App Connections description: Get the specified OCI Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OCI Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnection 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: updateOciAppConnection tags: - App Connections description: Update the specified OCI Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. privateKey: type: string minLength: 1 description: The private key content in PEM format used to sign API requests. required: - userOcid - tenancyOcid - region - fingerprint - privateKey additionalProperties: false description: The credentials used to connect with OCI. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the OCI Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the OCI Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for OCI Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OCI Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OCI Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OCI Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OCI Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OCI Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnection 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: deleteOciAppConnection tags: - App Connections description: Delete the specified OCI Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OCI Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnection 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/app-connections/oci/connection-name/{connectionName}: get: operationId: getOciAppConnectionByName tags: - App Connections description: Get the specified OCI Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the OCI Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the OCI Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnection 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/app-connections/oci/{connectionId}/rotate-credentials: post: operationId: rotateOciAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified OCI Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OCI Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oci method: type: string enum: - access-key credentials: type: object properties: userOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the user making the request. tenancyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure. region: type: string minLength: 1 description: The region identifier in Oracle Cloud Infrastructure where the vault is located. fingerprint: type: string minLength: 1 description: The fingerprint of the public key uploaded to the user's API keys. required: - userOcid - tenancyOcid - region - fingerprint additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OCI (Access Key) required: - appConnection 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/app-connections/oracledb: get: operationId: listOracleDbAppConnections tags: - App Connections description: List the OracleDB Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OracleDB Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnections 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 post: operationId: createOracleDbAppConnection tags: - App Connections description: Create an OracleDB Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-password description: The method used to authenticate with OracleDB. credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with OracleDB. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the OracleDB Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the OracleDB Connection. projectId: type: string description: The ID of the project to create the OracleDB Connection in. isPlatformManagedCredentials: type: boolean default: false description: Whether or not the OracleDB Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OracleDB Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OracleDB Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnection 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/app-connections/oracledb/available: get: operationId: listOracleDbAvailableAppConnections tags: - App Connections description: List the OracleDB Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OracleDB Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - oracledb name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/oracledb/{connectionId}: get: operationId: getOracleDbAppConnection tags: - App Connections description: Get the specified OracleDB Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OracleDB Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnection 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: updateOracleDbAppConnection tags: - App Connections description: Update the specified OracleDB Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. port: type: number description: The port number of the database. database: type: string minLength: 1 description: The name of the database to connect to. username: type: string minLength: 1 description: The username to connect to the database with. password: type: string minLength: 1 description: The password to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - port - database - username - password - sslEnabled - sslRejectUnauthorized additionalProperties: false description: The credentials used to connect with OracleDB. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the OracleDB Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the OracleDB Connection. isPlatformManagedCredentials: type: boolean description: Whether or not the OracleDB Connection credentials should be managed by Infisical. Once enabled this cannot be reversed. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OracleDB Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OracleDB Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OracleDB Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnection 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: deleteOracleDbAppConnection tags: - App Connections description: Delete the specified OracleDB Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OracleDB Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnection 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/app-connections/oracledb/connection-name/{connectionName}: get: operationId: getOracleDbAppConnectionByName tags: - App Connections description: Get the specified OracleDB Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the OracleDB Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the OracleDB Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnection 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/app-connections/oracledb/{connectionId}/rotate-credentials: post: operationId: rotateOracleDbAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified OracleDB Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OracleDB Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - oracledb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 description: The hostname of the database server. database: type: string minLength: 1 description: The name of the database to connect to. port: type: number description: The port number of the database. username: type: string minLength: 1 description: The username to connect to the database with. sslEnabled: type: boolean description: Whether or not to use SSL when connecting to the database. sslRejectUnauthorized: type: boolean description: Whether or not to reject unauthorized SSL certificates. sslCertificate: type: string description: The SSL certificate to use for connection. required: - host - database - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OracleDB (Username and Password) required: - appConnection 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/app-connections/1password: get: operationId: listOnePasswordAppConnections tags: - App Connections description: List the 1Password Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list 1Password Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnections 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 post: operationId: createOnePasswordAppConnection tags: - App Connections description: Create a 1Password Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with 1Password. credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to access the 1Password Connect Server. instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - apiToken - instanceUrl additionalProperties: false description: The credentials used to connect with 1Password. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the 1Password Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the 1Password Connection. projectId: type: string description: The ID of the project to create the 1Password Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for 1Password Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for 1Password Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for 1Password Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for 1Password Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for 1Password Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnection 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/app-connections/1password/available: get: operationId: listOnePasswordAvailableAppConnections tags: - App Connections description: List the 1Password Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list 1Password Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/1password/{connectionId}: get: operationId: getOnePasswordAppConnection tags: - App Connections description: Get the specified 1Password Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the 1Password Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnection 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: updateOnePasswordAppConnection tags: - App Connections description: Update the specified 1Password Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to access the 1Password Connect Server. instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - apiToken - instanceUrl additionalProperties: false description: The credentials used to connect with 1Password. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the 1Password Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the 1Password Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for 1Password Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for 1Password Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for 1Password Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for 1Password Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for 1Password Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the 1Password Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnection 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: deleteOnePasswordAppConnection tags: - App Connections description: Delete the specified 1Password Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the 1Password Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnection 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/app-connections/1password/connection-name/{connectionName}: get: operationId: getOnePasswordAppConnectionByName tags: - App Connections description: Get the specified 1Password Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the 1Password Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the 1Password Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnection 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/app-connections/1password/{connectionId}/rotate-credentials: post: operationId: rotateOnePasswordAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified 1Password Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the 1Password Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - 1password method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 description: The URL of the 1Password Connect Server instance to authenticate with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: 1Password (API Token) required: - appConnection 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/app-connections/heroku: get: operationId: listHerokuAppConnections tags: - App Connections description: List the Heroku Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Heroku Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnections 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 post: operationId: createHerokuAppConnection tags: - App Connections description: Create a Heroku Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - auth-token description: The method used to authenticate with Heroku. credentials: type: object properties: authToken: type: string minLength: 1 pattern: ^HRKU\- required: - authToken additionalProperties: false description: The credentials used to connect with Heroku. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with Heroku. credentials: anyOf: - type: object properties: code: type: string minLength: 1 required: - code additionalProperties: false - type: object properties: refreshToken: type: string minLength: 1 required: - refreshToken additionalProperties: false - type: object properties: authToken: type: string refreshToken: type: string expiresAt: type: string format: date-time required: - authToken - refreshToken - expiresAt additionalProperties: false description: The credentials used to connect with Heroku. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Heroku Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Heroku Connection. projectId: type: string description: The ID of the project to create the Heroku Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Heroku Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Heroku Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Heroku Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Heroku Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Heroku Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnection 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/app-connections/heroku/available: get: operationId: listHerokuAvailableAppConnections tags: - App Connections description: List the Heroku Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Heroku Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/heroku/{connectionId}: get: operationId: getHerokuAppConnection tags: - App Connections description: Get the specified Heroku Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Heroku Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnection 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: updateHerokuAppConnection tags: - App Connections description: Update the specified Heroku Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: authToken: type: string minLength: 1 pattern: ^HRKU\- required: - authToken additionalProperties: false - type: object properties: authToken: type: string refreshToken: type: string expiresAt: type: string format: date-time required: - authToken - refreshToken - expiresAt additionalProperties: false - type: object properties: refreshToken: type: string minLength: 1 required: - refreshToken additionalProperties: false - type: object properties: code: type: string minLength: 1 required: - code additionalProperties: false description: The credentials used to connect with Heroku. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Heroku Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Heroku Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Heroku Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Heroku Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Heroku Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Heroku Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Heroku Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Heroku Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnection 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: deleteHerokuAppConnection tags: - App Connections description: Delete the specified Heroku Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Heroku Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnection 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/app-connections/heroku/connection-name/{connectionName}: get: operationId: getHerokuAppConnectionByName tags: - App Connections description: Get the specified Heroku Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Heroku Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Heroku Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnection 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/app-connections/heroku/{connectionId}/rotate-credentials: post: operationId: rotateHerokuAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Heroku Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Heroku Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - auth-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (Auth Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - heroku method: type: string enum: - oauth credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Heroku (OAuth) required: - appConnection 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/app-connections/render: get: operationId: listRenderAppConnections tags: - App Connections description: List the Render Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Render Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnections 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 post: operationId: createRenderAppConnection tags: - App Connections description: Create a Render Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Render. credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false description: The credentials used to connect with Render. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Render Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Render Connection. projectId: type: string description: The ID of the project to create the Render Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Render Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Render Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Render Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Render Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Render Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnection 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/app-connections/render/available: get: operationId: listRenderAvailableAppConnections tags: - App Connections description: List the Render Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Render Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/render/{connectionId}: get: operationId: getRenderAppConnection tags: - App Connections description: Get the specified Render Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Render Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnection 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: updateRenderAppConnection tags: - App Connections description: Update the specified Render Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false description: The credentials used to connect with Render. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Render Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Render Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Render Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Render Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Render Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Render Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Render Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Render Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnection 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: deleteRenderAppConnection tags: - App Connections description: Delete the specified Render Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Render Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnection 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/app-connections/render/connection-name/{connectionName}: get: operationId: getRenderAppConnectionByName tags: - App Connections description: Get the specified Render Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Render Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Render Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnection 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/app-connections/render/{connectionId}/rotate-credentials: post: operationId: rotateRenderAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Render Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Render Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - render method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Render (API Key) required: - appConnection 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/app-connections/laravel-forge: get: operationId: listLaravelForgeAppConnections tags: - App Connections description: List the Laravel Forge Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Laravel Forge Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnections 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 post: operationId: createLaravelForgeAppConnection tags: - App Connections description: Create a Laravel Forge Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Laravel Forge. credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Laravel Forge. required: - apiToken additionalProperties: false description: The credentials used to connect with Laravel Forge. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Laravel Forge Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Laravel Forge Connection. projectId: type: string description: The ID of the project to create the Laravel Forge Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Laravel Forge Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Laravel Forge Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Laravel Forge Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Laravel Forge Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Laravel Forge Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnection 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/app-connections/laravel-forge/available: get: operationId: listLaravelForgeAvailableAppConnections tags: - App Connections description: List the Laravel Forge Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Laravel Forge Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/laravel-forge/{connectionId}: get: operationId: getLaravelForgeAppConnection tags: - App Connections description: Get the specified Laravel Forge Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Laravel Forge Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnection 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: updateLaravelForgeAppConnection tags: - App Connections description: Update the specified Laravel Forge Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Laravel Forge. required: - apiToken additionalProperties: false description: The credentials used to connect with Laravel Forge. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Laravel Forge Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Laravel Forge Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Laravel Forge Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Laravel Forge Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Laravel Forge Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Laravel Forge Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Laravel Forge Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Laravel Forge Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnection 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: deleteLaravelForgeAppConnection tags: - App Connections description: Delete the specified Laravel Forge Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Laravel Forge Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnection 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/app-connections/laravel-forge/connection-name/{connectionName}: get: operationId: getLaravelForgeAppConnectionByName tags: - App Connections description: Get the specified Laravel Forge Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Laravel Forge Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Laravel Forge Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnection 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/app-connections/laravel-forge/{connectionId}/rotate-credentials: post: operationId: rotateLaravelForgeAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Laravel Forge Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Laravel Forge Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - laravel-forge method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Laravel Forge (API Token) required: - appConnection 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/app-connections/flyio: get: operationId: listFlyioAppConnections tags: - App Connections description: List the Fly.io Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Fly.io Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnections 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 post: operationId: createFlyioAppConnection tags: - App Connections description: Create a Fly.io Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with Fly.io. credentials: type: object properties: accessToken: type: string minLength: 1 maxLength: 1000 pattern: ^FlyV1 description: The Access Token used to access fly.io. required: - accessToken additionalProperties: false description: The credentials used to connect with Fly.io. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Fly.io Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Fly.io Connection. projectId: type: string description: The ID of the project to create the Fly.io Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Fly.io Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Fly.io Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Fly.io Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Fly.io Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Fly.io Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnection 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/app-connections/flyio/available: get: operationId: listFlyioAvailableAppConnections tags: - App Connections description: List the Fly.io Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Fly.io Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/flyio/{connectionId}: get: operationId: getFlyioAppConnection tags: - App Connections description: Get the specified Fly.io Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Fly.io Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnection 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: updateFlyioAppConnection tags: - App Connections description: Update the specified Fly.io Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accessToken: type: string minLength: 1 maxLength: 1000 pattern: ^FlyV1 description: The Access Token used to access fly.io. required: - accessToken additionalProperties: false description: The credentials used to connect with Fly.io. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Fly.io Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Fly.io Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Fly.io Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Fly.io Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Fly.io Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Fly.io Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Fly.io Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Fly.io Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnection 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: deleteFlyioAppConnection tags: - App Connections description: Delete the specified Fly.io Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Fly.io Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnection 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/app-connections/flyio/connection-name/{connectionName}: get: operationId: getFlyioAppConnectionByName tags: - App Connections description: Get the specified Fly.io Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Fly.io Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Fly.io Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnection 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/app-connections/flyio/{connectionId}/rotate-credentials: post: operationId: rotateFlyioAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Fly.io Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Fly.io Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - flyio method: type: string enum: - access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Fly.io (Access Token) required: - appConnection 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/app-connections/gitlab: get: operationId: listGitLabAppConnections tags: - App Connections description: List the GitLab Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GitLab Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnections 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 post: operationId: createGitLabAppConnection tags: - App Connections description: Create a GitLab Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with GitLab. credentials: type: object properties: accessToken: type: string minLength: 1 description: The Access Token used to access GitLab. instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessToken - accessTokenType additionalProperties: false description: The credentials used to connect with GitLab. required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with GitLab. credentials: anyOf: - type: object properties: code: type: string minLength: 1 description: The OAuth code to use to connect with GitLab. instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. required: - code additionalProperties: false - type: object properties: refreshToken: type: string minLength: 1 instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. required: - refreshToken additionalProperties: false - type: object properties: accessToken: type: string refreshToken: type: string expiresAt: type: string format: date-time tokenType: type: string default: bearer createdAt: type: string instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. required: - accessToken - refreshToken - expiresAt additionalProperties: false description: The credentials used to connect with GitLab. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the GitLab Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the GitLab Connection. projectId: type: string description: The ID of the project to create the GitLab Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GitLab Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitLab Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitLab Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GitLab Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitLab Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnection 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/app-connections/gitlab/available: get: operationId: listGitLabAvailableAppConnections tags: - App Connections description: List the GitLab Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GitLab Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/gitlab/{connectionId}: get: operationId: getGitLabAppConnection tags: - App Connections description: Get the specified GitLab Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitLab Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnection 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: updateGitLabAppConnection tags: - App Connections description: Update the specified GitLab Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: accessToken: type: string minLength: 1 description: The Access Token used to access GitLab. instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessToken - accessTokenType additionalProperties: false - type: object properties: accessToken: type: string refreshToken: type: string expiresAt: type: string format: date-time tokenType: type: string default: bearer createdAt: type: string instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. required: - accessToken - refreshToken - expiresAt additionalProperties: false - type: object properties: refreshToken: type: string minLength: 1 instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. required: - refreshToken additionalProperties: false - type: object properties: code: type: string minLength: 1 description: The OAuth code to use to connect with GitLab. instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. required: - code additionalProperties: false description: The credentials used to connect with GitLab. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the GitLab Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the GitLab Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GitLab Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitLab Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitLab Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GitLab Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GitLab Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitLab Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnection 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: deleteGitLabAppConnection tags: - App Connections description: Delete the specified GitLab Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitLab Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnection 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/app-connections/gitlab/connection-name/{connectionName}: get: operationId: getGitLabAppConnectionByName tags: - App Connections description: Get the specified GitLab Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the GitLab Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the GitLab Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnection 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/app-connections/gitlab/{connectionId}/rotate-credentials: post: operationId: rotateGitLabAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified GitLab Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GitLab Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. accessTokenType: type: string enum: - project - personal - group description: The type of token used to connect with GitLab. required: - accessTokenType additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (Access Token) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - gitlab method: type: string enum: - oauth credentials: type: object properties: instanceUrl: type: string format: uri description: The GitLab instance URL to connect with. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GitLab (OAuth) required: - appConnection 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/app-connections/cloudflare: get: operationId: listCloudflareAppConnections tags: - App Connections description: List the Cloudflare Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Cloudflare Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnections 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 post: operationId: createCloudflareAppConnection tags: - App Connections description: Create a Cloudflare Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Cloudflare. credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 apiToken: type: string minLength: 1 maxLength: 256 required: - accountId - apiToken additionalProperties: false description: The credentials used to connect with Cloudflare. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Cloudflare Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Cloudflare Connection. projectId: type: string description: The ID of the project to create the Cloudflare Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Cloudflare Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Cloudflare Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Cloudflare Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Cloudflare Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Cloudflare Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnection 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/app-connections/cloudflare/available: get: operationId: listCloudflareAvailableAppConnections tags: - App Connections description: List the Cloudflare Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Cloudflare Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/cloudflare/{connectionId}: get: operationId: getCloudflareAppConnection tags: - App Connections description: Get the specified Cloudflare Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Cloudflare Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnection 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: updateCloudflareAppConnection tags: - App Connections description: Update the specified Cloudflare Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 apiToken: type: string minLength: 1 maxLength: 256 required: - accountId - apiToken additionalProperties: false description: The credentials used to connect with Cloudflare. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Cloudflare Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Cloudflare Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Cloudflare Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Cloudflare Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Cloudflare Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Cloudflare Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Cloudflare Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Cloudflare Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnection 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: deleteCloudflareAppConnection tags: - App Connections description: Delete the specified Cloudflare Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Cloudflare Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnection 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/app-connections/cloudflare/connection-name/{connectionName}: get: operationId: getCloudflareAppConnectionByName tags: - App Connections description: Get the specified Cloudflare Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Cloudflare Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Cloudflare Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnection 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/app-connections/cloudflare/{connectionId}/rotate-credentials: post: operationId: rotateCloudflareAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Cloudflare Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Cloudflare Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - cloudflare method: type: string enum: - api-token credentials: type: object properties: accountId: type: string minLength: 1 maxLength: 256 required: - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Cloudflare (API Token) required: - appConnection 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/app-connections/dns-made-easy: get: operationId: listDnsMadeEasyAppConnections tags: - App Connections description: List the DNS Made Easy Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DNS Made Easy Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnections 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 post: operationId: createDnsMadeEasyAppConnection tags: - App Connections description: Create a DNS Made Easy Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key-secret description: The method used to authenticate with DNS Made Easy. credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 secretKey: type: string minLength: 1 maxLength: 256 required: - apiKey - secretKey additionalProperties: false description: The credentials used to connect with DNS Made Easy. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the DNS Made Easy Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the DNS Made Easy Connection. projectId: type: string description: The ID of the project to create the DNS Made Easy Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DNS Made Easy Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DNS Made Easy Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DNS Made Easy Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DNS Made Easy Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DNS Made Easy Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnection 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/app-connections/dns-made-easy/available: get: operationId: listDnsMadeEasyAvailableAppConnections tags: - App Connections description: List the DNS Made Easy Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DNS Made Easy Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - dns-made-easy name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/dns-made-easy/{connectionId}: get: operationId: getDnsMadeEasyAppConnection tags: - App Connections description: Get the specified DNS Made Easy Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DNS Made Easy Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnection 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: updateDnsMadeEasyAppConnection tags: - App Connections description: Update the specified DNS Made Easy Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 secretKey: type: string minLength: 1 maxLength: 256 required: - apiKey - secretKey additionalProperties: false description: The credentials used to connect with DNS Made Easy. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the DNS Made Easy Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the DNS Made Easy Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DNS Made Easy Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DNS Made Easy Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DNS Made Easy Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DNS Made Easy Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DNS Made Easy Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DNS Made Easy Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnection 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: deleteDnsMadeEasyAppConnection tags: - App Connections description: Delete the specified DNS Made Easy Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DNS Made Easy Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnection 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/app-connections/dns-made-easy/connection-name/{connectionName}: get: operationId: getDnsMadeEasyAppConnectionByName tags: - App Connections description: Get the specified DNS Made Easy Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the DNS Made Easy Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the DNS Made Easy Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnection 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/app-connections/dns-made-easy/{connectionId}/rotate-credentials: post: operationId: rotateDnsMadeEasyAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified DNS Made Easy Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DNS Made Easy Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dns-made-easy method: type: string enum: - api-key-secret credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 required: - apiKey additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DNS Made Easy (API Key) required: - appConnection 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/app-connections/bitbucket: get: operationId: listBitbucketAppConnections tags: - App Connections description: List the Bitbucket Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Bitbucket Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnections 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 post: operationId: createBitbucketAppConnection tags: - App Connections description: Create a Bitbucket Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Bitbucket. credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to access Bitbucket. email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - apiToken - email additionalProperties: false description: The credentials used to connect with Bitbucket. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Bitbucket Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Bitbucket Connection. projectId: type: string description: The ID of the project to create the Bitbucket Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Bitbucket Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Bitbucket Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Bitbucket Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Bitbucket Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Bitbucket Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnection 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/app-connections/bitbucket/available: get: operationId: listBitbucketAvailableAppConnections tags: - App Connections description: List the Bitbucket Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Bitbucket Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/bitbucket/{connectionId}: get: operationId: getBitbucketAppConnection tags: - App Connections description: Get the specified Bitbucket Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Bitbucket Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnection 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: updateBitbucketAppConnection tags: - App Connections description: Update the specified Bitbucket Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to access Bitbucket. email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - apiToken - email additionalProperties: false description: The credentials used to connect with Bitbucket. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Bitbucket Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Bitbucket Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Bitbucket Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Bitbucket Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Bitbucket Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Bitbucket Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Bitbucket Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Bitbucket Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnection 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: deleteBitbucketAppConnection tags: - App Connections description: Delete the specified Bitbucket Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Bitbucket Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnection 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/app-connections/bitbucket/connection-name/{connectionName}: get: operationId: getBitbucketAppConnectionByName tags: - App Connections description: Get the specified Bitbucket Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Bitbucket Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Bitbucket Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnection 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/app-connections/bitbucket/{connectionId}/rotate-credentials: post: operationId: rotateBitbucketAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Bitbucket Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Bitbucket Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - bitbucket method: type: string enum: - api-token credentials: type: object properties: email: type: string format: email minLength: 1 maxLength: 255 description: The email used to access Bitbucket. required: - email additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Bitbucket (API Token) required: - appConnection 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/app-connections/zabbix: get: operationId: listZabbixAppConnections tags: - App Connections description: List the Zabbix Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Zabbix Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnections 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 post: operationId: createZabbixAppConnection tags: - App Connections description: Create a Zabbix Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Zabbix. credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 1000 description: The API Token used to access Zabbix. instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - apiToken - instanceUrl additionalProperties: false description: The credentials used to connect with Zabbix. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Zabbix Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Zabbix Connection. projectId: type: string description: The ID of the project to create the Zabbix Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Zabbix Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Zabbix Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Zabbix Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Zabbix Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Zabbix Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnection 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/app-connections/zabbix/available: get: operationId: listZabbixAvailableAppConnections tags: - App Connections description: List the Zabbix Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Zabbix Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/zabbix/{connectionId}: get: operationId: getZabbixAppConnection tags: - App Connections description: Get the specified Zabbix Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Zabbix Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnection 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: updateZabbixAppConnection tags: - App Connections description: Update the specified Zabbix Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 1000 description: The API Token used to access Zabbix. instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - apiToken - instanceUrl additionalProperties: false description: The credentials used to connect with Zabbix. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Zabbix Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Zabbix Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Zabbix Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Zabbix Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Zabbix Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Zabbix Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Zabbix Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Zabbix Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnection 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: deleteZabbixAppConnection tags: - App Connections description: Delete the specified Zabbix Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Zabbix Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnection 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/app-connections/zabbix/connection-name/{connectionName}: get: operationId: getZabbixAppConnectionByName tags: - App Connections description: Get the specified Zabbix Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Zabbix Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Zabbix Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnection 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/app-connections/zabbix/{connectionId}/rotate-credentials: post: operationId: rotateZabbixAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Zabbix Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Zabbix Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - zabbix method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Zabbix instance URL to connect with. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Zabbix (API Token) required: - appConnection 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/app-connections/railway: get: operationId: listRailwayAppConnections tags: - App Connections description: List the Railway Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Railway Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnections 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 post: operationId: createRailwayAppConnection tags: - App Connections description: Create a Railway Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to authenticate with Railway. required: - apiToken additionalProperties: false description: The credentials used to connect with Railway. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Railway Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Railway Connection. projectId: type: string description: The ID of the project to create the Railway Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Railway Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Railway Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Railway Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Railway Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Railway Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnection 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/app-connections/railway/available: get: operationId: listRailwayAvailableAppConnections tags: - App Connections description: List the Railway Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Railway Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/railway/{connectionId}: get: operationId: getRailwayAppConnection tags: - App Connections description: Get the specified Railway Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Railway Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnection 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: updateRailwayAppConnection tags: - App Connections description: Update the specified Railway Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to authenticate with Railway. required: - apiToken additionalProperties: false description: The credentials used to connect with Railway. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Railway Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Railway Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Railway Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Railway Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Railway Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Railway Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Railway Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Railway Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnection 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: deleteRailwayAppConnection tags: - App Connections description: Delete the specified Railway Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Railway Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnection 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/app-connections/railway/connection-name/{connectionName}: get: operationId: getRailwayAppConnectionByName tags: - App Connections description: Get the specified Railway Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Railway Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Railway Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnection 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/app-connections/railway/{connectionId}/rotate-credentials: post: operationId: rotateRailwayAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Railway Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Railway Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - railway method: type: string enum: - account-token - project-token - team-token description: The method used to authenticate with Railway. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Railway (Access Token) required: - appConnection 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/app-connections/checkly: get: operationId: listChecklyAppConnections tags: - App Connections description: List the Checkly Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Checkly Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnections 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 post: operationId: createChecklyAppConnection tags: - App Connections description: Create a Checkly Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 255 description: The API key used to authenticate with Checkly. required: - apiKey additionalProperties: false description: The credentials used to connect with Checkly. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Checkly Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Checkly Connection. projectId: type: string description: The ID of the project to create the Checkly Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Checkly Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Checkly Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Checkly Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Checkly Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Checkly Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnection 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/app-connections/checkly/available: get: operationId: listChecklyAvailableAppConnections tags: - App Connections description: List the Checkly Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Checkly Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/checkly/{connectionId}: get: operationId: getChecklyAppConnection tags: - App Connections description: Get the specified Checkly Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Checkly Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnection 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: updateChecklyAppConnection tags: - App Connections description: Update the specified Checkly Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 255 description: The API key used to authenticate with Checkly. required: - apiKey additionalProperties: false description: The credentials used to connect with Checkly. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Checkly Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Checkly Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Checkly Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Checkly Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Checkly Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Checkly Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Checkly Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Checkly Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnection 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: deleteChecklyAppConnection tags: - App Connections description: Delete the specified Checkly Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Checkly Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnection 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/app-connections/checkly/connection-name/{connectionName}: get: operationId: getChecklyAppConnectionByName tags: - App Connections description: Get the specified Checkly Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Checkly Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Checkly Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnection 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/app-connections/checkly/{connectionId}/rotate-credentials: post: operationId: rotateChecklyAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Checkly Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Checkly Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - checkly method: type: string enum: - api-key description: The method used to authenticate with Checkly. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Checkly (Access Token) required: - appConnection 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/app-connections/supabase: get: operationId: listSupabaseAppConnections tags: - App Connections description: List the Supabase Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Supabase Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnections 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 post: operationId: createSupabaseAppConnection tags: - App Connections description: Create a Supabase Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: accessKey: type: string minLength: 1 maxLength: 255 description: The Key used to access Supabase. instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. required: - accessKey additionalProperties: false description: The credentials used to connect with Supabase. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Supabase Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Supabase Connection. projectId: type: string description: The ID of the project to create the Supabase Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Supabase Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Supabase Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Supabase Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Supabase Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Supabase Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnection 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/app-connections/supabase/available: get: operationId: listSupabaseAvailableAppConnections tags: - App Connections description: List the Supabase Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Supabase Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/supabase/{connectionId}: get: operationId: getSupabaseAppConnection tags: - App Connections description: Get the specified Supabase Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Supabase Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnection 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: updateSupabaseAppConnection tags: - App Connections description: Update the specified Supabase Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accessKey: type: string minLength: 1 maxLength: 255 description: The Key used to access Supabase. instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. required: - accessKey additionalProperties: false description: The credentials used to connect with Supabase. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Supabase Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Supabase Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Supabase Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Supabase Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Supabase Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Supabase Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Supabase Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Supabase Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnection 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: deleteSupabaseAppConnection tags: - App Connections description: Delete the specified Supabase Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Supabase Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnection 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/app-connections/supabase/connection-name/{connectionName}: get: operationId: getSupabaseAppConnectionByName tags: - App Connections description: Get the specified Supabase Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Supabase Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Supabase Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnection 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/app-connections/supabase/{connectionId}/rotate-credentials: post: operationId: rotateSupabaseAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Supabase Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Supabase Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - supabase method: type: string enum: - access-token description: The method used to authenticate with Supabase. credentials: type: object properties: instanceUrl: type: string format: uri maxLength: 255 description: The URL used to access Supabase. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Supabase (Access Token) required: - appConnection 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/app-connections/digital-ocean: get: operationId: listDigitalOceanAppConnections tags: - App Connections description: List the DigitalOcean App Platform Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DigitalOcean App Platform Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnections 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 post: operationId: createDigitalOceanAppConnection tags: - App Connections description: Create a DigitalOcean App Platform Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to authenticate with Digital Ocean App Platform. required: - apiToken additionalProperties: false description: The credentials used to connect with DigitalOcean App Platform. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the DigitalOcean App Platform Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the DigitalOcean App Platform Connection. projectId: type: string description: The ID of the project to create the DigitalOcean App Platform Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DigitalOcean App Platform Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigitalOcean App Platform Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigitalOcean App Platform Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DigitalOcean App Platform Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigitalOcean App Platform Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnection 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/app-connections/digital-ocean/available: get: operationId: listDigitalOceanAvailableAppConnections tags: - App Connections description: List the DigitalOcean App Platform Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DigitalOcean App Platform Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/digital-ocean/{connectionId}: get: operationId: getDigitalOceanAppConnection tags: - App Connections description: Get the specified DigitalOcean App Platform Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigitalOcean App Platform Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnection 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: updateDigitalOceanAppConnection tags: - App Connections description: Update the specified DigitalOcean App Platform Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to authenticate with Digital Ocean App Platform. required: - apiToken additionalProperties: false description: The credentials used to connect with DigitalOcean App Platform. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the DigitalOcean App Platform Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the DigitalOcean App Platform Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DigitalOcean App Platform Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigitalOcean App Platform Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigitalOcean App Platform Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DigitalOcean App Platform Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigitalOcean App Platform Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigitalOcean App Platform Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnection 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: deleteDigitalOceanAppConnection tags: - App Connections description: Delete the specified DigitalOcean App Platform Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigitalOcean App Platform Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnection 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/app-connections/digital-ocean/connection-name/{connectionName}: get: operationId: getDigitalOceanAppConnectionByName tags: - App Connections description: Get the specified DigitalOcean App Platform Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the DigitalOcean App Platform Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the DigitalOcean App Platform Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnection 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/app-connections/digital-ocean/{connectionId}/rotate-credentials: post: operationId: rotateDigitalOceanAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified DigitalOcean App Platform Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigitalOcean App Platform Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digital-ocean method: type: string enum: - api-token description: The method used to authenticate with DigitalOcean App Platform. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigitalOcean App Platform (Access Token) required: - appConnection 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/app-connections/netlify: get: operationId: listNetlifyAppConnections tags: - App Connections description: List the Netlify Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Netlify Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnections 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 post: operationId: createNetlifyAppConnection tags: - App Connections description: Create a Netlify Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: accessToken: type: string minLength: 1 maxLength: 255 description: The Access token used to authenticate with Netlify. required: - accessToken additionalProperties: false description: The credentials used to connect with Netlify. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Netlify Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Netlify Connection. projectId: type: string description: The ID of the project to create the Netlify Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Netlify Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Netlify Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Netlify Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Netlify Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Netlify Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnection 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/app-connections/netlify/available: get: operationId: listNetlifyAvailableAppConnections tags: - App Connections description: List the Netlify Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Netlify Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/netlify/{connectionId}: get: operationId: getNetlifyAppConnection tags: - App Connections description: Get the specified Netlify Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Netlify Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnection 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: updateNetlifyAppConnection tags: - App Connections description: Update the specified Netlify Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accessToken: type: string minLength: 1 maxLength: 255 description: The Access token used to authenticate with Netlify. required: - accessToken additionalProperties: false description: The credentials used to connect with Netlify. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Netlify Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Netlify Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Netlify Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Netlify Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Netlify Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Netlify Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Netlify Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Netlify Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnection 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: deleteNetlifyAppConnection tags: - App Connections description: Delete the specified Netlify Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Netlify Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnection 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/app-connections/netlify/connection-name/{connectionName}: get: operationId: getNetlifyAppConnectionByName tags: - App Connections description: Get the specified Netlify Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Netlify Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Netlify Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnection 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/app-connections/netlify/{connectionId}/rotate-credentials: post: operationId: rotateNetlifyAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Netlify Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Netlify Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netlify method: type: string enum: - access-token description: The method used to authenticate with Netlify. credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Netlify (Access Token) required: - appConnection 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/app-connections/northflank: get: operationId: listNorthflankAppConnections tags: - App Connections description: List the Northflank Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Northflank Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnections 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 post: operationId: createNorthflankAppConnection tags: - App Connections description: Create a Northflank Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Northflank. credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Northflank. required: - apiToken additionalProperties: false description: The credentials used to connect with Northflank. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Northflank Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Northflank Connection. projectId: type: string description: The ID of the project to create the Northflank Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Northflank Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Northflank Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Northflank Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Northflank Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Northflank Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnection 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/app-connections/northflank/available: get: operationId: listNorthflankAvailableAppConnections tags: - App Connections description: List the Northflank Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Northflank Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/northflank/{connectionId}: get: operationId: getNorthflankAppConnection tags: - App Connections description: Get the specified Northflank Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Northflank Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnection 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: updateNorthflankAppConnection tags: - App Connections description: Update the specified Northflank Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Northflank. required: - apiToken additionalProperties: false description: The credentials used to connect with Northflank. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Northflank Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Northflank Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Northflank Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Northflank Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Northflank Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Northflank Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Northflank Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Northflank Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnection 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: deleteNorthflankAppConnection tags: - App Connections description: Delete the specified Northflank Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Northflank Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnection 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/app-connections/northflank/connection-name/{connectionName}: get: operationId: getNorthflankAppConnectionByName tags: - App Connections description: Get the specified Northflank Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Northflank Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Northflank Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnection 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/app-connections/northflank/{connectionId}/rotate-credentials: post: operationId: rotateNorthflankAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Northflank Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Northflank Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - northflank method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Northflank (API Token) required: - appConnection 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/app-connections/okta: get: operationId: listOktaAppConnections tags: - App Connections description: List the Okta Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Okta Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnections 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 post: operationId: createOktaAppConnection tags: - App Connections description: Create an Okta Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Okta. credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. apiToken: type: string minLength: 1 description: The API token used to authenticate with Okta. required: - instanceUrl - apiToken additionalProperties: false description: The credentials used to connect with Okta. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Okta Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Okta Connection. projectId: type: string description: The ID of the project to create the Okta Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Okta Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Okta Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Okta Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Okta Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Okta Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnection 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/app-connections/okta/available: get: operationId: listOktaAvailableAppConnections tags: - App Connections description: List the Okta Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Okta Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - okta name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/okta/{connectionId}: get: operationId: getOktaAppConnection tags: - App Connections description: Get the specified Okta Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Okta Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnection 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: updateOktaAppConnection tags: - App Connections description: Update the specified Okta Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. apiToken: type: string minLength: 1 description: The API token used to authenticate with Okta. required: - instanceUrl - apiToken additionalProperties: false description: The credentials used to connect with Okta. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Okta Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Okta Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Okta Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Okta Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Okta Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Okta Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Okta Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Okta Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnection 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: deleteOktaAppConnection tags: - App Connections description: Delete the specified Okta Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Okta Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnection 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/app-connections/okta/connection-name/{connectionName}: get: operationId: getOktaAppConnectionByName tags: - App Connections description: Get the specified Okta Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Okta Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Okta Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnection 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/app-connections/okta/{connectionId}/rotate-credentials: post: operationId: rotateOktaAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Okta Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Okta Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - okta method: type: string enum: - api-token credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The URL used to access your Okta organization. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Okta (API Token) required: - appConnection 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/app-connections/redis: get: operationId: listRedisAppConnections tags: - App Connections description: List the Redis Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Redis Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnections 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 post: operationId: createRedisAppConnection tags: - App Connections description: Create a Redis Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-password description: The method used to authenticate with Redis. credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 password: type: string minLength: 1 sslRejectUnauthorized: type: boolean sslEnabled: type: boolean sslCertificate: type: string required: - host - port - username - sslRejectUnauthorized - sslEnabled additionalProperties: false description: The credentials used to connect with Redis. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Redis Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Redis Connection. projectId: type: string description: The ID of the project to create the Redis Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Redis Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Redis Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Redis Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Redis Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Redis Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnection 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/app-connections/redis/available: get: operationId: listRedisAvailableAppConnections tags: - App Connections description: List the Redis Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Redis Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - redis name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/redis/{connectionId}: get: operationId: getRedisAppConnection tags: - App Connections description: Get the specified Redis Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Redis Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnection 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: updateRedisAppConnection tags: - App Connections description: Update the specified Redis Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 password: type: string minLength: 1 sslRejectUnauthorized: type: boolean sslEnabled: type: boolean sslCertificate: type: string required: - host - port - username - sslRejectUnauthorized - sslEnabled additionalProperties: false description: The credentials used to connect with Redis. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Redis Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Redis Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Redis Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Redis Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Redis Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Redis Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Redis Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Redis Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnection 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: deleteRedisAppConnection tags: - App Connections description: Delete the specified Redis Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Redis Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnection 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/app-connections/redis/connection-name/{connectionName}: get: operationId: getRedisAppConnectionByName tags: - App Connections description: Get the specified Redis Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Redis Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Redis Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnection 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/app-connections/redis/{connectionId}/rotate-credentials: post: operationId: rotateRedisAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Redis Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Redis Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - redis method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 sslEnabled: type: boolean sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - host - port - username - sslEnabled - sslRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Redis (Username and Password) required: - appConnection 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/app-connections/mongodb: get: operationId: listMongoDbAppConnections tags: - App Connections description: List the MongoDB Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list MongoDB Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnections 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 post: operationId: createMongoDbAppConnection tags: - App Connections description: Create a MongoDB Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-password description: The method used to authenticate with MongoDB. credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 password: type: string minLength: 1 database: type: string minLength: 1 tlsRejectUnauthorized: type: boolean tlsEnabled: type: boolean tlsCertificate: type: string required: - host - port - username - password - database - tlsRejectUnauthorized - tlsEnabled additionalProperties: false description: The credentials used to connect with MongoDB. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the MongoDB Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the MongoDB Connection. projectId: type: string description: The ID of the project to create the MongoDB Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for MongoDB Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MongoDB Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MongoDB Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for MongoDB Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MongoDB Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnection 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/app-connections/mongodb/available: get: operationId: listMongoDbAvailableAppConnections tags: - App Connections description: List the MongoDB Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list MongoDB Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - mongodb name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/mongodb/{connectionId}: get: operationId: getMongoDbAppConnection tags: - App Connections description: Get the specified MongoDB Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MongoDB Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnection 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: updateMongoDbAppConnection tags: - App Connections description: Update the specified MongoDB Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 password: type: string minLength: 1 database: type: string minLength: 1 tlsRejectUnauthorized: type: boolean tlsEnabled: type: boolean tlsCertificate: type: string required: - host - port - username - password - database - tlsRejectUnauthorized - tlsEnabled additionalProperties: false description: The credentials used to connect with MongoDB. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the MongoDB Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the MongoDB Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for MongoDB Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MongoDB Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MongoDB Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for MongoDB Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for MongoDB Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MongoDB Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnection 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: deleteMongoDbAppConnection tags: - App Connections description: Delete the specified MongoDB Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MongoDB Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnection 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/app-connections/mongodb/connection-name/{connectionName}: get: operationId: getMongoDbAppConnectionByName tags: - App Connections description: Get the specified MongoDB Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the MongoDB Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the MongoDB Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnection 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/app-connections/mongodb/{connectionId}/rotate-credentials: post: operationId: rotateMongoDbAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified MongoDB Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the MongoDB Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - mongodb method: type: string enum: - username-and-password credentials: type: object properties: host: type: string minLength: 1 port: type: number username: type: string minLength: 1 database: type: string minLength: 1 tlsEnabled: type: boolean tlsRejectUnauthorized: type: boolean tlsCertificate: type: string required: - host - port - username - database - tlsEnabled - tlsRejectUnauthorized additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false required: - appConnection 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/app-connections/chef: get: operationId: listChefAppConnections tags: - App Connections description: List the Chef Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Chef Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnections 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 post: operationId: createChefAppConnection tags: - App Connections description: Create a Chef Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - user-key description: The method used to authenticate with Chef. credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. privateKey: type: string minLength: 1 maxLength: 16384 description: The private key used to access Chef. required: - orgName - userName - privateKey additionalProperties: false description: The credentials used to connect with Chef. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Chef Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Chef Connection. projectId: type: string description: The ID of the project to create the Chef Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Chef Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Chef Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Chef Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Chef Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Chef Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnection 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/app-connections/chef/available: get: operationId: listChefAvailableAppConnections tags: - App Connections description: List the Chef Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Chef Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/chef/{connectionId}: get: operationId: getChefAppConnection tags: - App Connections description: Get the specified Chef Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Chef Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnection 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: updateChefAppConnection tags: - App Connections description: Update the specified Chef Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. privateKey: type: string minLength: 1 maxLength: 16384 description: The private key used to access Chef. required: - orgName - userName - privateKey additionalProperties: false description: The credentials used to connect with Chef. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Chef Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Chef Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Chef Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Chef Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Chef Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Chef Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Chef Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Chef Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnection 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: deleteChefAppConnection tags: - App Connections description: Delete the specified Chef Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Chef Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnection 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/app-connections/chef/connection-name/{connectionName}: get: operationId: getChefAppConnectionByName tags: - App Connections description: Get the specified Chef Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Chef Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Chef Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnection 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/app-connections/chef/{connectionId}/rotate-credentials: post: operationId: rotateChefAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Chef Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Chef Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - chef method: type: string enum: - user-key credentials: type: object properties: serverUrl: type: string format: uri description: The URL of the Chef server to connect to. orgName: type: string minLength: 1 maxLength: 256 description: The short name of the Chef organization to connect to. userName: type: string minLength: 1 maxLength: 256 description: The username used to access Chef. required: - orgName - userName additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Chef (User Key) required: - appConnection 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/app-connections/octopus-deploy: get: operationId: listOctopusDeployAppConnections tags: - App Connections description: List the Octopus Deploy Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Octopus Deploy Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnections 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 post: operationId: createOctopusDeployAppConnection tags: - App Connections description: Create an Octopus Deploy Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Octopus Deploy. credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. apiKey: type: string minLength: 1 description: The API key used to authenticate with Octopus Deploy. required: - instanceUrl - apiKey additionalProperties: false description: The credentials used to connect with Octopus Deploy. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Octopus Deploy Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Octopus Deploy Connection. projectId: type: string description: The ID of the project to create the Octopus Deploy Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Octopus Deploy Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Octopus Deploy Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Octopus Deploy Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Octopus Deploy Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Octopus Deploy Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnection 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/app-connections/octopus-deploy/available: get: operationId: listOctopusDeployAvailableAppConnections tags: - App Connections description: List the Octopus Deploy Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Octopus Deploy Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/octopus-deploy/{connectionId}: get: operationId: getOctopusDeployAppConnection tags: - App Connections description: Get the specified Octopus Deploy Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Octopus Deploy Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnection 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: updateOctopusDeployAppConnection tags: - App Connections description: Update the specified Octopus Deploy Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. apiKey: type: string minLength: 1 description: The API key used to authenticate with Octopus Deploy. required: - instanceUrl - apiKey additionalProperties: false description: The credentials used to connect with Octopus Deploy. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Octopus Deploy Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Octopus Deploy Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Octopus Deploy Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Octopus Deploy Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Octopus Deploy Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Octopus Deploy Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Octopus Deploy Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Octopus Deploy Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnection 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: deleteOctopusDeployAppConnection tags: - App Connections description: Delete the specified Octopus Deploy Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Octopus Deploy Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnection 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/app-connections/octopus-deploy/connection-name/{connectionName}: get: operationId: getOctopusDeployAppConnectionByName tags: - App Connections description: Get the specified Octopus Deploy Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Octopus Deploy Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Octopus Deploy Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnection 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/app-connections/octopus-deploy/{connectionId}/rotate-credentials: post: operationId: rotateOctopusDeployAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Octopus Deploy Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Octopus Deploy Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - octopus-deploy method: type: string enum: - api-key credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 255 description: The Octopus Deploy instance URL to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Octopus Deploy (API Key) required: - appConnection 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/app-connections/ssh: get: operationId: listSshAppConnections tags: - App Connections description: List the SSH Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list SSH Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnections 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 post: operationId: createSshAppConnection tags: - App Connections description: Create a SSH Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - password description: The method used to authenticate with SSH. credentials: type: object properties: host: type: string minLength: 1 description: The hostname or IP address of the SSH server. port: type: integer minimum: 1 maximum: 65535 description: 'The port number of the SSH server (default: 22).' username: type: string minLength: 1 description: The username for SSH authentication. password: type: string minLength: 1 description: The password for SSH authentication (required when authMethod is 'password'). required: - host - port - username - password additionalProperties: false description: The credentials used to connect with SSH. configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - method - credentials additionalProperties: false - type: object properties: method: type: string enum: - ssh-key description: The method used to authenticate with SSH. credentials: type: object properties: host: type: string minLength: 1 description: The hostname or IP address of the SSH server. port: type: integer minimum: 1 maximum: 65535 description: 'The port number of the SSH server (default: 22).' username: type: string minLength: 1 description: The username for SSH authentication. privateKey: type: string minLength: 1 description: The private key in PEM format for SSH authentication (required when authMethod is 'ssh-key'). passphrase: type: string description: The passphrase for the private key, if encrypted (optional, only for 'ssh-key' authMethod). required: - host - port - username - privateKey additionalProperties: false description: The credentials used to connect with SSH. configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the SSH Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the SSH Connection. projectId: type: string description: The ID of the project to create the SSH Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for SSH Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for SSH Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for SSH Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnection 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/app-connections/ssh/available: get: operationId: listSshAvailableAppConnections tags: - App Connections description: List the SSH Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list SSH Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - ssh name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/ssh/{connectionId}: get: operationId: getSshAppConnection tags: - App Connections description: Get the specified SSH Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SSH Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnection 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: updateSshAppConnection tags: - App Connections description: Update the specified SSH Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: anyOf: - type: object properties: host: type: string minLength: 1 description: The hostname or IP address of the SSH server. port: type: integer minimum: 1 maximum: 65535 description: 'The port number of the SSH server (default: 22).' username: type: string minLength: 1 description: The username for SSH authentication. password: type: string minLength: 1 description: The password for SSH authentication (required when authMethod is 'password'). required: - host - port - username - password additionalProperties: false - type: object properties: host: type: string minLength: 1 description: The hostname or IP address of the SSH server. port: type: integer minimum: 1 maximum: 65535 description: 'The port number of the SSH server (default: 22).' username: type: string minLength: 1 description: The username for SSH authentication. privateKey: type: string minLength: 1 description: The private key in PEM format for SSH authentication (required when authMethod is 'ssh-key'). passphrase: type: string description: The passphrase for the private key, if encrypted (optional, only for 'ssh-key' authMethod). required: - host - port - username - privateKey additionalProperties: false description: The credentials used to connect with SSH. configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the SSH Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the SSH Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for SSH Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for SSH Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for SSH Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SSH Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnection 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: deleteSshAppConnection tags: - App Connections description: Delete the specified SSH Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SSH Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnection 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/app-connections/ssh/connection-name/{connectionName}: get: operationId: getSshAppConnectionByName tags: - App Connections description: Get the specified SSH Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the SSH Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the SSH Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnection 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/app-connections/ssh/{connectionId}/rotate-credentials: post: operationId: rotateSshAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified SSH Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SSH Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - password credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (Password) - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ssh method: type: string enum: - ssh-key credentials: type: object properties: host: type: string port: type: number username: type: string required: - host - port - username additionalProperties: false configuration: type: object properties: blockedUsers: type: string description: A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu'). additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SSH (SSH Key) required: - appConnection 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/app-connections/dbt: get: operationId: listDbtAppConnections tags: - App Connections description: List the DBT Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DBT Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnections 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 post: operationId: createDbtAppConnection tags: - App Connections description: Create a DBT Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to authenticate with DBT. instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - apiToken - instanceUrl - accountId additionalProperties: false description: The credentials used to connect with DBT. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the DBT Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the DBT Connection. projectId: type: string description: The ID of the project to create the DBT Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DBT Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DBT Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DBT Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DBT Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DBT Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnection 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/app-connections/dbt/available: get: operationId: listDbtAvailableAppConnections tags: - App Connections description: List the DBT Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DBT Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - dbt name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/dbt/{connectionId}: get: operationId: getDbtAppConnection tags: - App Connections description: Get the specified DBT Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DBT Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnection 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: updateDbtAppConnection tags: - App Connections description: Update the specified DBT Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 255 description: The API token used to authenticate with DBT. instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - apiToken - instanceUrl - accountId additionalProperties: false description: The credentials used to connect with DBT. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the DBT Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the DBT Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DBT Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DBT Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DBT Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DBT Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DBT Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DBT Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnection 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: deleteDbtAppConnection tags: - App Connections description: Delete the specified DBT Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DBT Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnection 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/app-connections/dbt/connection-name/{connectionName}: get: operationId: getDbtAppConnectionByName tags: - App Connections description: Get the specified DBT Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the DBT Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the DBT Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnection 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/app-connections/dbt/{connectionId}/rotate-credentials: post: operationId: rotateDbtAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified DBT Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DBT Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - dbt method: type: string enum: - api-token description: The method used to authenticate with DBT. credentials: type: object properties: instanceUrl: type: string minLength: 1 format: uri description: The base URL of your DBT instance. accountId: type: string minLength: 1 maxLength: 255 description: The account ID of your DBT account. required: - instanceUrl - accountId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DBT (API Token) required: - appConnection 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/app-connections/smb: get: operationId: listSmbAppConnections tags: - App Connections description: List the SMB Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list SMB Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnections 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 post: operationId: createSmbAppConnection tags: - App Connections description: Create a SMB Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: method: type: string enum: - credentials description: The method used to authenticate with SMB. credentials: type: object properties: host: type: string minLength: 1 maxLength: 253 description: The hostname or IP address of the Windows server. port: type: integer minimum: 1 maximum: 65535 description: The SMB port (defaults to 445). domain: type: string maxLength: 255 description: The Windows domain name (optional). username: type: string minLength: 1 maxLength: 104 description: The username for SMB authentication. password: type: string minLength: 1 description: The password for SMB authentication. required: - host - port - username - password additionalProperties: false description: The credentials used to connect with SMB. required: - method - credentials - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the SMB Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the SMB Connection. projectId: type: string description: The ID of the project to create the SMB Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for SMB Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for SMB Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for SMB Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnection 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/app-connections/smb/available: get: operationId: listSmbAvailableAppConnections tags: - App Connections description: List the SMB Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list SMB Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - smb name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/smb/{connectionId}: get: operationId: getSmbAppConnection tags: - App Connections description: Get the specified SMB Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SMB Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnection 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: updateSmbAppConnection tags: - App Connections description: Update the specified SMB Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: host: type: string minLength: 1 maxLength: 253 description: The hostname or IP address of the Windows server. port: type: integer minimum: 1 maximum: 65535 description: The SMB port (defaults to 445). domain: type: string maxLength: 255 description: The Windows domain name (optional). username: type: string minLength: 1 maxLength: 104 description: The username for SMB authentication. password: type: string minLength: 1 description: The password for SMB authentication. required: - host - port - username - password additionalProperties: false description: The credentials used to connect with SMB. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the SMB Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the SMB Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for SMB Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for SMB Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for SMB Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SMB Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnection 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: deleteSmbAppConnection tags: - App Connections description: Delete the specified SMB Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SMB Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnection 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/app-connections/smb/connection-name/{connectionName}: get: operationId: getSmbAppConnectionByName tags: - App Connections description: Get the specified SMB Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the SMB Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the SMB Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnection 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/app-connections/smb/{connectionId}/rotate-credentials: post: operationId: rotateSmbAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified SMB Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the SMB Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - smb method: type: string enum: - credentials credentials: type: object properties: host: type: string port: type: number domain: type: string username: type: string required: - host - port - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: SMB required: - appConnection 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/app-connections/open-router: get: operationId: listOpenRouterAppConnections tags: - App Connections description: List the OpenRouter Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OpenRouter Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnections 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 post: operationId: createOpenRouterAppConnection tags: - App Connections description: Create an OpenRouter Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with OpenRouter. credentials: type: object properties: apiKey: type: string minLength: 1 description: The OpenRouter Provisioning API key used to manage API keys. required: - apiKey additionalProperties: false description: The credentials used to connect with OpenRouter. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the OpenRouter Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the OpenRouter Connection. projectId: type: string description: The ID of the project to create the OpenRouter Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for OpenRouter Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OpenRouter Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OpenRouter Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OpenRouter Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OpenRouter Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnection 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/app-connections/open-router/available: get: operationId: listOpenRouterAvailableAppConnections tags: - App Connections description: List the OpenRouter Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OpenRouter Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - open-router name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/open-router/{connectionId}: get: operationId: getOpenRouterAppConnection tags: - App Connections description: Get the specified OpenRouter Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OpenRouter Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnection 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: updateOpenRouterAppConnection tags: - App Connections description: Update the specified OpenRouter Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 description: The OpenRouter Provisioning API key used to manage API keys. required: - apiKey additionalProperties: false description: The credentials used to connect with OpenRouter. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the OpenRouter Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the OpenRouter Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for OpenRouter Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OpenRouter Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OpenRouter Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OpenRouter Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OpenRouter Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OpenRouter Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnection 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: deleteOpenRouterAppConnection tags: - App Connections description: Delete the specified OpenRouter Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OpenRouter Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnection 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/app-connections/open-router/connection-name/{connectionName}: get: operationId: getOpenRouterAppConnectionByName tags: - App Connections description: Get the specified OpenRouter Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the OpenRouter Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the OpenRouter Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnection 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/app-connections/open-router/{connectionId}/rotate-credentials: post: operationId: rotateOpenRouterAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified OpenRouter Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OpenRouter Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - open-router method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OpenRouter (API Key) required: - appConnection 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/app-connections/circleci: get: operationId: listCircleciAppConnections tags: - App Connections description: List the CircleCI Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list CircleCI Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnections 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 post: operationId: createCircleciAppConnection tags: - App Connections description: Create a CircleCI Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with CircleCI. credentials: type: object properties: apiToken: type: string minLength: 1 host: type: string required: - apiToken additionalProperties: false description: The credentials used to connect with CircleCI. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the CircleCI Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the CircleCI Connection. projectId: type: string description: The ID of the project to create the CircleCI Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for CircleCI Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for CircleCI Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for CircleCI Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for CircleCI Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for CircleCI Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnection 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/app-connections/circleci/available: get: operationId: listCircleciAvailableAppConnections tags: - App Connections description: List the CircleCI Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list CircleCI Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/circleci/{connectionId}: get: operationId: getCircleciAppConnection tags: - App Connections description: Get the specified CircleCI Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the CircleCI Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnection 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: updateCircleciAppConnection tags: - App Connections description: Update the specified CircleCI Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 host: type: string required: - apiToken additionalProperties: false description: The credentials used to connect with CircleCI. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the CircleCI Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the CircleCI Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for CircleCI Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for CircleCI Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for CircleCI Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for CircleCI Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for CircleCI Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the CircleCI Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnection 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: deleteCircleciAppConnection tags: - App Connections description: Delete the specified CircleCI Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the CircleCI Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnection 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/app-connections/circleci/connection-name/{connectionName}: get: operationId: getCircleciAppConnectionByName tags: - App Connections description: Get the specified CircleCI Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the CircleCI Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the CircleCI Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnection 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/app-connections/circleci/{connectionId}/rotate-credentials: post: operationId: rotateCircleciAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified CircleCI Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the CircleCI Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - circleci method: type: string enum: - api-token credentials: type: object properties: host: type: string additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: CircleCI (Personal Access Token) required: - appConnection 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/app-connections/azure-entra-id: get: operationId: listAzureEntraIdAppConnections tags: - App Connections description: List the Azure Entra ID Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure Entra ID Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnections 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 post: operationId: createAzureEntraIdAppConnection tags: - App Connections description: Create an Azure Entra ID Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - client-secret description: The method used to authenticate with Azure Entra ID. credentials: type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 clientSecret: type: string minLength: 1 tenantId: type: string format: uuid minLength: 1 required: - clientId - clientSecret - tenantId additionalProperties: false description: The credentials used to connect with Azure Entra ID. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Azure Entra ID Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure Entra ID Connection. projectId: type: string description: The ID of the project to create the Azure Entra ID Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure Entra ID Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Entra ID Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Entra ID Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure Entra ID Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Entra ID Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnection 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/app-connections/azure-entra-id/available: get: operationId: listAzureEntraIdAvailableAppConnections tags: - App Connections description: List the Azure Entra ID Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Azure Entra ID Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/azure-entra-id/{connectionId}: get: operationId: getAzureEntraIdAppConnection tags: - App Connections description: Get the specified Azure Entra ID Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Entra ID Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnection 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: updateAzureEntraIdAppConnection tags: - App Connections description: Update the specified Azure Entra ID Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: clientId: type: string format: uuid minLength: 1 maxLength: 50 clientSecret: type: string minLength: 1 tenantId: type: string format: uuid minLength: 1 required: - clientId - clientSecret - tenantId additionalProperties: false description: The credentials used to connect with Azure Entra ID. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Azure Entra ID Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure Entra ID Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Azure Entra ID Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Entra ID Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Entra ID Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Azure Entra ID Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Azure Entra ID Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Entra ID Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnection 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: deleteAzureEntraIdAppConnection tags: - App Connections description: Delete the specified Azure Entra ID Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Entra ID Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnection 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/app-connections/azure-entra-id/connection-name/{connectionName}: get: operationId: getAzureEntraIdAppConnectionByName tags: - App Connections description: Get the specified Azure Entra ID Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Azure Entra ID Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Azure Entra ID Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnection 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/app-connections/azure-entra-id/{connectionId}/rotate-credentials: post: operationId: rotateAzureEntraIdAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Azure Entra ID Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Azure Entra ID Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - azure-entra-id method: type: string enum: - client-secret credentials: type: object properties: clientId: type: string tenantId: type: string required: - clientId - tenantId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Azure Entra ID (Client Secret) required: - appConnection 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/app-connections/venafi: get: operationId: listVenafiAppConnections tags: - App Connections description: List the Venafi TLS Protect Cloud Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Venafi TLS Protect Cloud Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnections 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 post: operationId: createVenafiAppConnection tags: - App Connections description: Create a Venafi TLS Protect Cloud Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Venafi TLS Protect Cloud. credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - apiKey - region additionalProperties: false description: The credentials used to connect with Venafi TLS Protect Cloud. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Venafi TLS Protect Cloud Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Venafi TLS Protect Cloud Connection. projectId: type: string description: The ID of the project to create the Venafi TLS Protect Cloud Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Venafi TLS Protect Cloud Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TLS Protect Cloud Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TLS Protect Cloud Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Venafi TLS Protect Cloud Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TLS Protect Cloud Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnection 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/app-connections/venafi/available: get: operationId: listVenafiAvailableAppConnections tags: - App Connections description: List the Venafi TLS Protect Cloud Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Venafi TLS Protect Cloud Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - venafi name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/venafi/{connectionId}: get: operationId: getVenafiAppConnection tags: - App Connections description: Get the specified Venafi TLS Protect Cloud Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TLS Protect Cloud Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnection 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: updateVenafiAppConnection tags: - App Connections description: Update the specified Venafi TLS Protect Cloud Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 256 region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - apiKey - region additionalProperties: false description: The credentials used to connect with Venafi TLS Protect Cloud. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Venafi TLS Protect Cloud Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Venafi TLS Protect Cloud Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Venafi TLS Protect Cloud Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TLS Protect Cloud Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TLS Protect Cloud Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Venafi TLS Protect Cloud Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TLS Protect Cloud Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TLS Protect Cloud Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnection 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: deleteVenafiAppConnection tags: - App Connections description: Delete the specified Venafi TLS Protect Cloud Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TLS Protect Cloud Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnection 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/app-connections/venafi/connection-name/{connectionName}: get: operationId: getVenafiAppConnectionByName tags: - App Connections description: Get the specified Venafi TLS Protect Cloud Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Venafi TLS Protect Cloud Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Venafi TLS Protect Cloud Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnection 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/app-connections/venafi/{connectionId}/rotate-credentials: post: operationId: rotateVenafiAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Venafi TLS Protect Cloud Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TLS Protect Cloud Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu - au - uk - sg - ca description: The region of the Venafi TLS Protect Cloud instance required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TLS Protect Cloud (API Key) required: - appConnection 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/app-connections/venafi-tpp: get: operationId: listVenafiTppAppConnections tags: - App Connections description: List the Venafi TPP Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Venafi TPP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnections 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 post: operationId: createVenafiTppAppConnection tags: - App Connections description: Create a Venafi TPP Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - oauth description: The method used to authenticate with Venafi TPP. credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' password: type: string minLength: 1 maxLength: 255 description: The password used to authenticate with Venafi TPP. required: - tppUrl - clientId - username - password additionalProperties: false description: The credentials used to connect with Venafi TPP. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Venafi TPP Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Venafi TPP Connection. projectId: type: string description: The ID of the project to create the Venafi TPP Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Venafi TPP Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Venafi TPP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TPP Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnection 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/app-connections/venafi-tpp/available: get: operationId: listVenafiTppAvailableAppConnections tags: - App Connections description: List the Venafi TPP Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Venafi TPP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - venafi-tpp name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/venafi-tpp/{connectionId}: get: operationId: getVenafiTppAppConnection tags: - App Connections description: Get the specified Venafi TPP Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TPP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnection 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: updateVenafiTppAppConnection tags: - App Connections description: Update the specified Venafi TPP Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' password: type: string minLength: 1 maxLength: 255 description: The password used to authenticate with Venafi TPP. required: - tppUrl - clientId - username - password additionalProperties: false description: The credentials used to connect with Venafi TPP. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Venafi TPP Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Venafi TPP Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Venafi TPP Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Venafi TPP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Venafi TPP Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TPP Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnection 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: deleteVenafiTppAppConnection tags: - App Connections description: Delete the specified Venafi TPP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TPP Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnection 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/app-connections/venafi-tpp/connection-name/{connectionName}: get: operationId: getVenafiTppAppConnectionByName tags: - App Connections description: Get the specified Venafi TPP Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Venafi TPP Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Venafi TPP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnection 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/app-connections/venafi-tpp/{connectionId}/rotate-credentials: post: operationId: rotateVenafiTppAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Venafi TPP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Venafi TPP Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - venafi-tpp method: type: string enum: - oauth credentials: type: object properties: tppUrl: type: string minLength: 1 maxLength: 512 description: The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS. clientId: type: string minLength: 1 maxLength: 255 description: The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication. username: type: string minLength: 1 maxLength: 255 description: 'The username used to authenticate with Venafi TPP. Supports formats: ''DOMAIN\\username'', ''username@domain.com'', or local usernames.' required: - tppUrl - clientId - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Venafi TPP (OAuth) required: - appConnection 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/app-connections/external-infisical: get: operationId: listExternalInfisicalAppConnections tags: - App Connections description: List the Infisical Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Infisical Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnections 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 post: operationId: createExternalInfisicalAppConnection tags: - App Connections description: Create an Infisical Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - machine-identity-universal-auth description: The method used to authenticate with Infisical. credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 machineIdentityClientSecret: type: string minLength: 1 maxLength: 512 required: - instanceUrl - machineIdentityClientId - machineIdentityClientSecret additionalProperties: false description: The credentials used to connect with Infisical. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Infisical Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Infisical Connection. projectId: type: string description: The ID of the project to create the Infisical Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Infisical Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Infisical Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Infisical Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Infisical Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Infisical Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnection 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/app-connections/external-infisical/available: get: operationId: listExternalInfisicalAvailableAppConnections tags: - App Connections description: List the Infisical Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Infisical Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/external-infisical/{connectionId}: get: operationId: getExternalInfisicalAppConnection tags: - App Connections description: Get the specified Infisical Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Infisical Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnection 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: updateExternalInfisicalAppConnection tags: - App Connections description: Update the specified Infisical Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 machineIdentityClientSecret: type: string minLength: 1 maxLength: 512 required: - instanceUrl - machineIdentityClientId - machineIdentityClientSecret additionalProperties: false description: The credentials used to connect with Infisical. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Infisical Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Infisical Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Infisical Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Infisical Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Infisical Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Infisical Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Infisical Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Infisical Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnection 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: deleteExternalInfisicalAppConnection tags: - App Connections description: Delete the specified Infisical Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Infisical Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnection 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/app-connections/external-infisical/connection-name/{connectionName}: get: operationId: getExternalInfisicalAppConnectionByName tags: - App Connections description: Get the specified Infisical Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Infisical Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Infisical Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnection 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/app-connections/external-infisical/{connectionId}/rotate-credentials: post: operationId: rotateExternalInfisicalAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Infisical Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Infisical Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - external-infisical method: type: string enum: - machine-identity-universal-auth credentials: type: object properties: instanceUrl: type: string format: uri minLength: 1 maxLength: 512 machineIdentityClientId: type: string format: uuid minLength: 1 required: - instanceUrl - machineIdentityClientId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Infisical (Machine Identity - Universal Auth) required: - appConnection 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/app-connections/doppler: get: operationId: listDopplerAppConnections tags: - App Connections description: List the Doppler Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Doppler Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnections 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 post: operationId: createDopplerAppConnection tags: - App Connections description: Create a Doppler Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Doppler. credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 512 required: - apiToken additionalProperties: false description: The credentials used to connect with Doppler. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Doppler Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Doppler Connection. projectId: type: string description: The ID of the project to create the Doppler Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Doppler Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Doppler Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Doppler Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Doppler Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Doppler Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnection 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/app-connections/doppler/available: get: operationId: listDopplerAvailableAppConnections tags: - App Connections description: List the Doppler Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Doppler Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - doppler name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/doppler/{connectionId}: get: operationId: getDopplerAppConnection tags: - App Connections description: Get the specified Doppler Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Doppler Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnection 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: updateDopplerAppConnection tags: - App Connections description: Update the specified Doppler Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 maxLength: 512 required: - apiToken additionalProperties: false description: The credentials used to connect with Doppler. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Doppler Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Doppler Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Doppler Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Doppler Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Doppler Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Doppler Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Doppler Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Doppler Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnection 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: deleteDopplerAppConnection tags: - App Connections description: Delete the specified Doppler Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Doppler Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnection 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/app-connections/doppler/connection-name/{connectionName}: get: operationId: getDopplerAppConnectionByName tags: - App Connections description: Get the specified Doppler Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Doppler Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Doppler Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnection 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/app-connections/doppler/{connectionId}/rotate-credentials: post: operationId: rotateDopplerAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Doppler Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Doppler Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - doppler method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Doppler (API Token) required: - appConnection 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/app-connections/netscaler: get: operationId: listNetscalerAppConnections tags: - App Connections description: List the NetScaler Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list NetScaler Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnections 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 post: operationId: createNetscalerAppConnection tags: - App Connections description: Create a NetScaler Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - basic-auth description: The method used to authenticate with NetScaler. credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 password: type: string minLength: 1 maxLength: 512 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username - password additionalProperties: false description: The credentials used to connect with NetScaler. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the NetScaler Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the NetScaler Connection. projectId: type: string description: The ID of the project to create the NetScaler Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for NetScaler Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for NetScaler Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for NetScaler Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnection 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/app-connections/netscaler/available: get: operationId: listNetscalerAvailableAppConnections tags: - App Connections description: List the NetScaler Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list NetScaler Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - netscaler name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/netscaler/{connectionId}: get: operationId: getNetscalerAppConnection tags: - App Connections description: Get the specified NetScaler Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the NetScaler Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnection 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: updateNetscalerAppConnection tags: - App Connections description: Update the specified NetScaler Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 password: type: string minLength: 1 maxLength: 512 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username - password additionalProperties: false description: The credentials used to connect with NetScaler. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the NetScaler Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the NetScaler Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for NetScaler Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for NetScaler Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for NetScaler Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the NetScaler Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnection 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: deleteNetscalerAppConnection tags: - App Connections description: Delete the specified NetScaler Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the NetScaler Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnection 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/app-connections/netscaler/connection-name/{connectionName}: get: operationId: getNetscalerAppConnectionByName tags: - App Connections description: Get the specified NetScaler Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the NetScaler Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the NetScaler Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnection 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/app-connections/netscaler/{connectionId}/rotate-credentials: post: operationId: rotateNetscalerAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified NetScaler Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the NetScaler Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - netscaler method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: NetScaler (Basic Auth) required: - appConnection 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/app-connections/anthropic: get: operationId: listAnthropicAppConnections tags: - App Connections description: List the Anthropic Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Anthropic Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnections 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 post: operationId: createAnthropicAppConnection tags: - App Connections description: Create an Anthropic Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Anthropic. credentials: type: object properties: apiKey: type: string minLength: 1 description: The Anthropic API key used to authenticate with the Anthropic API. required: - apiKey additionalProperties: false description: The credentials used to connect with Anthropic. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Anthropic Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Anthropic Connection. projectId: type: string description: The ID of the project to create the Anthropic Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Anthropic Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Anthropic Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Anthropic Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Anthropic Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Anthropic Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnection 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/app-connections/anthropic/available: get: operationId: listAnthropicAvailableAppConnections tags: - App Connections description: List the Anthropic Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Anthropic Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - anthropic name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/anthropic/{connectionId}: get: operationId: getAnthropicAppConnection tags: - App Connections description: Get the specified Anthropic Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Anthropic Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnection 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: updateAnthropicAppConnection tags: - App Connections description: Update the specified Anthropic Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 description: The Anthropic API key used to authenticate with the Anthropic API. required: - apiKey additionalProperties: false description: The credentials used to connect with Anthropic. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Anthropic Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Anthropic Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Anthropic Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Anthropic Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Anthropic Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Anthropic Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Anthropic Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Anthropic Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnection 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: deleteAnthropicAppConnection tags: - App Connections description: Delete the specified Anthropic Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Anthropic Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnection 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/app-connections/anthropic/connection-name/{connectionName}: get: operationId: getAnthropicAppConnectionByName tags: - App Connections description: Get the specified Anthropic Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Anthropic Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Anthropic Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnection 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/app-connections/anthropic/{connectionId}/rotate-credentials: post: operationId: rotateAnthropicAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Anthropic Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Anthropic Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - anthropic method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Anthropic (API Key) required: - appConnection 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/app-connections/ovh: get: operationId: listOvhAppConnections tags: - App Connections description: List the OVH Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OVH Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnections 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 post: operationId: createOvhAppConnection tags: - App Connections description: Create an OVH Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - certificate description: The method used to authenticate with OVH. credentials: type: object properties: privateKey: type: string minLength: 1 description: The PEM-encoded private key issued by OVH OKMS for client certificate authentication (including the -----BEGIN/END PRIVATE KEY----- markers). certificate: type: string minLength: 1 description: The PEM-encoded public certificate issued by OVH OKMS for client certificate authentication (including the -----BEGIN/END CERTIFICATE----- markers). okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - privateKey - certificate - okmsDomain - okmsId additionalProperties: false description: The credentials used to connect with OVH. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the OVH Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the OVH Connection. projectId: type: string description: The ID of the project to create the OVH Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for OVH Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OVH Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OVH Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OVH Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OVH Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnection 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/app-connections/ovh/available: get: operationId: listOvhAvailableAppConnections tags: - App Connections description: List the OVH Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list OVH Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/ovh/{connectionId}: get: operationId: getOvhAppConnection tags: - App Connections description: Get the specified OVH Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OVH Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnection 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: updateOvhAppConnection tags: - App Connections description: Update the specified OVH Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: privateKey: type: string minLength: 1 description: The PEM-encoded private key issued by OVH OKMS for client certificate authentication (including the -----BEGIN/END PRIVATE KEY----- markers). certificate: type: string minLength: 1 description: The PEM-encoded public certificate issued by OVH OKMS for client certificate authentication (including the -----BEGIN/END CERTIFICATE----- markers). okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - privateKey - certificate - okmsDomain - okmsId additionalProperties: false description: The credentials used to connect with OVH. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the OVH Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the OVH Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for OVH Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OVH Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OVH Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for OVH Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for OVH Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OVH Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnection 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: deleteOvhAppConnection tags: - App Connections description: Delete the specified OVH Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OVH Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnection 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/app-connections/ovh/connection-name/{connectionName}: get: operationId: getOvhAppConnectionByName tags: - App Connections description: Get the specified OVH Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the OVH Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the OVH Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnection 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/app-connections/ovh/{connectionId}/rotate-credentials: post: operationId: rotateOvhAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified OVH Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the OVH Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ovh method: type: string enum: - certificate credentials: type: object properties: okmsDomain: type: string minLength: 1 format: uri description: The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net'). okmsId: type: string minLength: 1 description: The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls. required: - okmsDomain - okmsId additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: OVH (Certificate) required: - appConnection 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/app-connections/devin: get: operationId: listDevinAppConnections tags: - App Connections description: List the Devin Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Devin Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnections 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 post: operationId: createDevinAppConnection tags: - App Connections description: Create a Devin Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Devin. credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 1000 pattern: ^cog\_ description: The Devin service-user API key used to authenticate against the Devin v3 API. required: - apiKey additionalProperties: false description: The credentials used to connect with Devin. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Devin Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Devin Connection. projectId: type: string description: The ID of the project to create the Devin Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Devin Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Devin Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Devin Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Devin Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Devin Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnection 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/app-connections/devin/available: get: operationId: listDevinAvailableAppConnections tags: - App Connections description: List the Devin Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Devin Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/devin/{connectionId}: get: operationId: getDevinAppConnection tags: - App Connections description: Get the specified Devin Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Devin Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnection 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: updateDevinAppConnection tags: - App Connections description: Update the specified Devin Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 maxLength: 1000 pattern: ^cog\_ description: The Devin service-user API key used to authenticate against the Devin v3 API. required: - apiKey additionalProperties: false description: The credentials used to connect with Devin. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Devin Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Devin Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Devin Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Devin Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Devin Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Devin Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Devin Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Devin Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnection 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: deleteDevinAppConnection tags: - App Connections description: Delete the specified Devin Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Devin Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnection 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/app-connections/devin/connection-name/{connectionName}: get: operationId: getDevinAppConnectionByName tags: - App Connections description: Get the specified Devin Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Devin Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Devin Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnection 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/app-connections/devin/{connectionId}/rotate-credentials: post: operationId: rotateDevinAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Devin Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Devin Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - devin method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Devin (API Key) required: - appConnection 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/app-connections/ona: get: operationId: listOnaAppConnections tags: - App Connections description: List the Ona Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Ona Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnections 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 post: operationId: createOnaAppConnection tags: - App Connections description: Create an Ona Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - personal-access-token description: The method used to authenticate with Ona. credentials: type: object properties: personalAccessToken: type: string minLength: 1 description: The Personal Access Token used to authenticate with Ona. required: - personalAccessToken additionalProperties: false description: The credentials used to connect with Ona. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Ona Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Ona Connection. projectId: type: string description: The ID of the project to create the Ona Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Ona Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Ona Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Ona Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Ona Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Ona Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnection 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/app-connections/ona/available: get: operationId: listOnaAvailableAppConnections tags: - App Connections description: List the Ona Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Ona Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/ona/{connectionId}: get: operationId: getOnaAppConnection tags: - App Connections description: Get the specified Ona Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Ona Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnection 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: updateOnaAppConnection tags: - App Connections description: Update the specified Ona Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: personalAccessToken: type: string minLength: 1 description: The Personal Access Token used to authenticate with Ona. required: - personalAccessToken additionalProperties: false description: The credentials used to connect with Ona. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Ona Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Ona Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Ona Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Ona Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Ona Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Ona Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Ona Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Ona Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnection 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: deleteOnaAppConnection tags: - App Connections description: Delete the specified Ona Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Ona Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnection 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/app-connections/ona/connection-name/{connectionName}: get: operationId: getOnaAppConnectionByName tags: - App Connections description: Get the specified Ona Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Ona Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Ona Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnection 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/app-connections/ona/{connectionId}/rotate-credentials: post: operationId: rotateOnaAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Ona Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Ona Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - ona method: type: string enum: - personal-access-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Ona (Personal Access Token) required: - appConnection 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/app-connections/digicert: get: operationId: listDigicertAppConnections tags: - App Connections description: List the DigiCert Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DigiCert Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnections 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 post: operationId: createDigicertAppConnection tags: - App Connections description: Create a DigiCert Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with DigiCert. credentials: type: object properties: apiKey: type: string minLength: 1 description: The CertCentral API Key used to authenticate with DigiCert. region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - apiKey - region additionalProperties: false description: The credentials used to connect with DigiCert. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the DigiCert Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the DigiCert Connection. projectId: type: string description: The ID of the project to create the DigiCert Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DigiCert Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigiCert Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigiCert Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DigiCert Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigiCert Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnection 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/app-connections/digicert/available: get: operationId: listDigicertAvailableAppConnections tags: - App Connections description: List the DigiCert Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list DigiCert Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - digicert name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/digicert/{connectionId}: get: operationId: getDigicertAppConnection tags: - App Connections description: Get the specified DigiCert Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigiCert Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnection 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: updateDigicertAppConnection tags: - App Connections description: Update the specified DigiCert Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 description: The CertCentral API Key used to authenticate with DigiCert. region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - apiKey - region additionalProperties: false description: The credentials used to connect with DigiCert. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the DigiCert Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the DigiCert Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for DigiCert Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigiCert Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigiCert Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for DigiCert Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for DigiCert Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigiCert Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnection 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: deleteDigicertAppConnection tags: - App Connections description: Delete the specified DigiCert Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigiCert Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnection 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/app-connections/digicert/connection-name/{connectionName}: get: operationId: getDigicertAppConnectionByName tags: - App Connections description: Get the specified DigiCert Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the DigiCert Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the DigiCert Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnection 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/app-connections/digicert/{connectionId}/rotate-credentials: post: operationId: rotateDigicertAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified DigiCert Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the DigiCert Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - digicert method: type: string enum: - api-key credentials: type: object properties: region: type: string enum: - us - eu description: The CertCentral region the API key belongs to (us or eu). required: - region additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: DigiCert (API Key) required: - appConnection 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/app-connections/godaddy: get: operationId: listGodaddyAppConnections tags: - App Connections description: List the GoDaddy Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GoDaddy Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnections 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 post: operationId: createGodaddyAppConnection tags: - App Connections description: Create a GoDaddy Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with GoDaddy. credentials: type: object properties: apiKey: type: string minLength: 1 description: The GoDaddy API Key used to authenticate with the GoDaddy API. apiSecret: type: string minLength: 1 description: The GoDaddy API Secret used to authenticate with the GoDaddy API. required: - apiKey - apiSecret additionalProperties: false description: The credentials used to connect with GoDaddy. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the GoDaddy Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the GoDaddy Connection. projectId: type: string description: The ID of the project to create the GoDaddy Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GoDaddy Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GoDaddy Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GoDaddy Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GoDaddy Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GoDaddy Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnection 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/app-connections/godaddy/available: get: operationId: listGodaddyAvailableAppConnections tags: - App Connections description: List the GoDaddy Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list GoDaddy Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - godaddy name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/godaddy/{connectionId}: get: operationId: getGodaddyAppConnection tags: - App Connections description: Get the specified GoDaddy Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GoDaddy Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnection 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: updateGodaddyAppConnection tags: - App Connections description: Update the specified GoDaddy Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiKey: type: string minLength: 1 description: The GoDaddy API Key used to authenticate with the GoDaddy API. apiSecret: type: string minLength: 1 description: The GoDaddy API Secret used to authenticate with the GoDaddy API. required: - apiKey - apiSecret additionalProperties: false description: The credentials used to connect with GoDaddy. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the GoDaddy Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the GoDaddy Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for GoDaddy Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GoDaddy Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GoDaddy Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for GoDaddy Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for GoDaddy Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GoDaddy Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnection 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: deleteGodaddyAppConnection tags: - App Connections description: Delete the specified GoDaddy Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GoDaddy Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnection 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/app-connections/godaddy/connection-name/{connectionName}: get: operationId: getGodaddyAppConnectionByName tags: - App Connections description: Get the specified GoDaddy Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the GoDaddy Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the GoDaddy Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnection 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/app-connections/godaddy/{connectionId}/rotate-credentials: post: operationId: rotateGodaddyAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified GoDaddy Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the GoDaddy Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - godaddy method: type: string enum: - api-key credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: GoDaddy (API Key) required: - appConnection 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/app-connections/travis-ci: get: operationId: listTravisCIAppConnections tags: - App Connections description: List the Travis CI Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Travis CI Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnections 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 post: operationId: createTravisCIAppConnection tags: - App Connections description: Create a Travis CI Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-token description: The method used to authenticate with Travis CI. credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Travis CI. required: - apiToken additionalProperties: false description: The credentials used to connect with Travis CI. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Travis CI Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Travis CI Connection. projectId: type: string description: The ID of the project to create the Travis CI Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Travis CI Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Travis CI Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Travis CI Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Travis CI Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Travis CI Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnection 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/app-connections/travis-ci/available: get: operationId: listTravisCIAvailableAppConnections tags: - App Connections description: List the Travis CI Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Travis CI Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/travis-ci/{connectionId}: get: operationId: getTravisCIAppConnection tags: - App Connections description: Get the specified Travis CI Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Travis CI Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnection 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: updateTravisCIAppConnection tags: - App Connections description: Update the specified Travis CI Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: apiToken: type: string minLength: 1 description: The API token used to authenticate with Travis CI. required: - apiToken additionalProperties: false description: The credentials used to connect with Travis CI. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Travis CI Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Travis CI Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Travis CI Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Travis CI Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Travis CI Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Travis CI Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Travis CI Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Travis CI Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnection 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: deleteTravisCIAppConnection tags: - App Connections description: Delete the specified Travis CI Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Travis CI Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnection 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/app-connections/travis-ci/connection-name/{connectionName}: get: operationId: getTravisCIAppConnectionByName tags: - App Connections description: Get the specified Travis CI Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Travis CI Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Travis CI Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnection 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/app-connections/travis-ci/{connectionId}/rotate-credentials: post: operationId: rotateTravisCIAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Travis CI Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Travis CI Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - travis-ci method: type: string enum: - api-token credentials: type: object properties: {} additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Travis CI (API Token) required: - appConnection 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/app-connections/salesforce: get: operationId: listSalesforceAppConnections tags: - App Connections description: List the Salesforce Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Salesforce Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnections 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 post: operationId: createSalesforceAppConnection tags: - App Connections description: Create a Salesforce Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - client-credentials description: The method used to authenticate with Salesforce. credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. consumerKey: type: string minLength: 1 description: The Consumer Key of your Salesforce External App. consumerSecret: type: string minLength: 1 description: The Consumer Secret of your Salesforce External App. required: - instanceUrl - consumerKey - consumerSecret additionalProperties: false description: The credentials used to connect with Salesforce. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Salesforce Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Salesforce Connection. projectId: type: string description: The ID of the project to create the Salesforce Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Salesforce Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Salesforce Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Salesforce Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Salesforce Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Salesforce Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnection 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/app-connections/salesforce/available: get: operationId: listSalesforceAvailableAppConnections tags: - App Connections description: List the Salesforce Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Salesforce Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - salesforce name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/salesforce/{connectionId}: get: operationId: getSalesforceAppConnection tags: - App Connections description: Get the specified Salesforce Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Salesforce Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnection 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: updateSalesforceAppConnection tags: - App Connections description: Update the specified Salesforce Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. consumerKey: type: string minLength: 1 description: The Consumer Key of your Salesforce External App. consumerSecret: type: string minLength: 1 description: The Consumer Secret of your Salesforce External App. required: - instanceUrl - consumerKey - consumerSecret additionalProperties: false description: The credentials used to connect with Salesforce. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Salesforce Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Salesforce Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Salesforce Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Salesforce Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Salesforce Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Salesforce Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Salesforce Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Salesforce Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnection 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: deleteSalesforceAppConnection tags: - App Connections description: Delete the specified Salesforce Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Salesforce Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnection 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/app-connections/salesforce/connection-name/{connectionName}: get: operationId: getSalesforceAppConnectionByName tags: - App Connections description: Get the specified Salesforce Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Salesforce Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Salesforce Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnection 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/app-connections/salesforce/{connectionId}/rotate-credentials: post: operationId: rotateSalesforceAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Salesforce Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Salesforce Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - salesforce method: type: string enum: - client-credentials credentials: type: object properties: instanceUrl: type: string minLength: 1 description: The instance URL of the Salesforce org to connect to. required: - instanceUrl additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Salesforce (Client Credentials) required: - appConnection 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/app-connections/snowflake: get: operationId: listSnowflakeAppConnections tags: - App Connections description: List the Snowflake Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Snowflake Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnections 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 post: operationId: createSnowflakeAppConnection tags: - App Connections description: Create a Snowflake Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - username-and-token description: The method used to authenticate with Snowflake. credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. password: type: string minLength: 1 description: The Programmatic Access Token used to authenticate with Snowflake. required: - account - username - password additionalProperties: false description: The credentials used to connect with Snowflake. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Snowflake Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Snowflake Connection. projectId: type: string description: The ID of the project to create the Snowflake Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Snowflake Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Snowflake Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Snowflake Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Snowflake Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Snowflake Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnection 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/app-connections/snowflake/available: get: operationId: listSnowflakeAvailableAppConnections tags: - App Connections description: List the Snowflake Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Snowflake Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/snowflake/{connectionId}: get: operationId: getSnowflakeAppConnection tags: - App Connections description: Get the specified Snowflake Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Snowflake Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnection 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: updateSnowflakeAppConnection tags: - App Connections description: Update the specified Snowflake Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. password: type: string minLength: 1 description: The Programmatic Access Token used to authenticate with Snowflake. required: - account - username - password additionalProperties: false description: The credentials used to connect with Snowflake. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Snowflake Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Snowflake Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Snowflake Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Snowflake Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Snowflake Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Snowflake Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Snowflake Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Snowflake Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnection 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: deleteSnowflakeAppConnection tags: - App Connections description: Delete the specified Snowflake Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Snowflake Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnection 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/app-connections/snowflake/connection-name/{connectionName}: get: operationId: getSnowflakeAppConnectionByName tags: - App Connections description: Get the specified Snowflake Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Snowflake Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Snowflake Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnection 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/app-connections/snowflake/{connectionId}/rotate-credentials: post: operationId: rotateSnowflakeAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Snowflake Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Snowflake Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - snowflake method: type: string enum: - username-and-token credentials: type: object properties: account: type: string minLength: 1 description: The Snowflake account identifier (e.g., xy12345.us-east-1). username: type: string minLength: 1 description: The username (login name) used to authenticate with Snowflake. required: - account - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Snowflake (Username and Token) required: - appConnection 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/app-connections/datadog: get: operationId: listDatadogAppConnections tags: - App Connections description: List the Datadog Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Datadog Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnections 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 post: operationId: createDatadogAppConnection tags: - App Connections description: Create a Datadog Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - api-key description: The method used to authenticate with Datadog. credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). apiKey: type: string minLength: 1 description: The Datadog API key used to authenticate. applicationKey: type: string minLength: 1 description: The Datadog Application key used to authenticate. required: - url - apiKey - applicationKey additionalProperties: false description: The credentials used to connect with Datadog. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Datadog Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Datadog Connection. projectId: type: string description: The ID of the project to create the Datadog Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Datadog Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Datadog Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Datadog Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Datadog Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Datadog Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnection 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/app-connections/datadog/available: get: operationId: listDatadogAvailableAppConnections tags: - App Connections description: List the Datadog Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Datadog Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - datadog name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/datadog/{connectionId}: get: operationId: getDatadogAppConnection tags: - App Connections description: Get the specified Datadog Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Datadog Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnection 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: updateDatadogAppConnection tags: - App Connections description: Update the specified Datadog Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). apiKey: type: string minLength: 1 description: The Datadog API key used to authenticate. applicationKey: type: string minLength: 1 description: The Datadog Application key used to authenticate. required: - url - apiKey - applicationKey additionalProperties: false description: The credentials used to connect with Datadog. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Datadog Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Datadog Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Datadog Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Datadog Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Datadog Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Datadog Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Datadog Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Datadog Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnection 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: deleteDatadogAppConnection tags: - App Connections description: Delete the specified Datadog Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Datadog Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnection 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/app-connections/datadog/connection-name/{connectionName}: get: operationId: getDatadogAppConnectionByName tags: - App Connections description: Get the specified Datadog Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Datadog Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Datadog Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnection 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/app-connections/datadog/{connectionId}/rotate-credentials: post: operationId: rotateDatadogAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Datadog Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Datadog Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - datadog method: type: string enum: - api-key credentials: type: object properties: url: type: string format: uri minLength: 1 maxLength: 255 description: The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com'). required: - url additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Datadog (API Key) required: - appConnection 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/app-connections/f5-big-ip: get: operationId: listF5BigIpAppConnections tags: - App Connections description: List the F5 BIG-IP Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list F5 BIG-IP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnections 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 post: operationId: createF5BigIpAppConnection tags: - App Connections description: Create a F5 BIG-IP Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - basic-auth description: The method used to authenticate with F5 BIG-IP. credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 password: type: string minLength: 1 maxLength: 512 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username - password additionalProperties: false description: The credentials used to connect with F5 BIG-IP. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the F5 BIG-IP Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the F5 BIG-IP Connection. projectId: type: string description: The ID of the project to create the F5 BIG-IP Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for F5 BIG-IP Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for F5 BIG-IP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for F5 BIG-IP Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnection 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/app-connections/f5-big-ip/available: get: operationId: listF5BigIpAvailableAppConnections tags: - App Connections description: List the F5 BIG-IP Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list F5 BIG-IP Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - f5-big-ip name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/f5-big-ip/{connectionId}: get: operationId: getF5BigIpAppConnection tags: - App Connections description: Get the specified F5 BIG-IP Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the F5 BIG-IP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnection 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: updateF5BigIpAppConnection tags: - App Connections description: Update the specified F5 BIG-IP Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 password: type: string minLength: 1 maxLength: 512 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username - password additionalProperties: false description: The credentials used to connect with F5 BIG-IP. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the F5 BIG-IP Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the F5 BIG-IP Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for F5 BIG-IP Connections. gatewayId: type: string format: uuid nullable: true description: The Gateway ID to use for this connection. gatewayPoolId: type: string format: uuid nullable: true description: The Gateway Pool ID to use for this connection. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for F5 BIG-IP Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for F5 BIG-IP Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the F5 BIG-IP Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnection 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: deleteF5BigIpAppConnection tags: - App Connections description: Delete the specified F5 BIG-IP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the F5 BIG-IP Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnection 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/app-connections/f5-big-ip/connection-name/{connectionName}: get: operationId: getF5BigIpAppConnectionByName tags: - App Connections description: Get the specified F5 BIG-IP Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the F5 BIG-IP Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the F5 BIG-IP Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnection 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/app-connections/f5-big-ip/{connectionId}/rotate-credentials: post: operationId: rotateF5BigIpAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified F5 BIG-IP Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the F5 BIG-IP Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - f5-big-ip method: type: string enum: - basic-auth credentials: type: object properties: hostname: type: string minLength: 1 maxLength: 512 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 sslRejectUnauthorized: type: boolean sslCertificate: type: string required: - hostname - username additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: F5 BIG-IP (Basic Auth) required: - appConnection 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/app-connections/convex: get: operationId: listConvexAppConnections tags: - App Connections description: List the Convex Connections for the current organization or project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Convex Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnections 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 post: operationId: createConvexAppConnection tags: - App Connections description: Create a Convex Connection. requestBody: required: true content: application/json: schema: allOf: - anyOf: - type: object properties: method: type: string enum: - personal-access-token description: The method used to authenticate with Convex. credentials: type: object properties: accessToken: type: string minLength: 1 description: The Convex deploy key or access token used to authenticate with the Convex API. instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. required: - accessToken additionalProperties: false description: The credentials used to connect with Convex. required: - method - credentials additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Convex Connection to create. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: An optional description for the Convex Connection. projectId: type: string description: The ID of the project to create the Convex Connection in. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Convex Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Convex Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Convex Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Convex Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Convex Connections. required: - name responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnection 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/app-connections/convex/available: get: operationId: listConvexAvailableAppConnections tags: - App Connections description: List the Convex Connections the current user has permission to establish connections within this project. parameters: - schema: type: string in: query name: projectId required: false description: The ID of the project to list Convex Connections from. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnections: type: array items: type: object properties: app: type: string enum: - convex name: type: string id: type: string format: uuid projectId: type: string nullable: true orgId: type: string required: - app - name - id - orgId additionalProperties: false required: - appConnections 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/app-connections/convex/{connectionId}: get: operationId: getConvexAppConnection tags: - App Connections description: Get the specified Convex Connection by ID. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Convex Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnection 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: updateConvexAppConnection tags: - App Connections description: Update the specified Convex Connection. requestBody: required: true content: application/json: schema: allOf: - type: object properties: credentials: type: object properties: accessToken: type: string minLength: 1 description: The Convex deploy key or access token used to authenticate with the Convex API. instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. required: - accessToken additionalProperties: false description: The credentials used to connect with Convex. - type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Convex Connection. Must be slug-friendly. description: type: string maxLength: 256 nullable: true description: The updated description of the Convex Connection. isPlatformManagedCredentials: type: boolean enum: - false description: Not supported for Convex Connections. gatewayId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Convex Connections. gatewayPoolId: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Convex Connections. isAutoRotationEnabled: type: boolean enum: - false description: Not supported for Convex Connections. rotation: anyOf: - not: {} - enum: - 'null' nullable: true description: Not supported for Convex Connections. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Convex Connection to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnection 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: deleteConvexAppConnection tags: - App Connections description: Delete the specified Convex Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Convex Connection to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnection 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/app-connections/convex/connection-name/{connectionName}: get: operationId: getConvexAppConnectionByName tags: - App Connections description: Get the specified Convex Connection by name. parameters: - schema: type: string in: query name: projectId required: false description: The project ID of the Convex Connection is associated with. Leave unspecified to get organization-level connections. - schema: type: string minLength: 1 in: path name: connectionName required: true description: The name of the Convex Connection to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnection 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/app-connections/convex/{connectionId}/rotate-credentials: post: operationId: rotateConvexAppConnectionCredentials tags: - App Connections description: Rotate the credentials for the specified Convex Connection. parameters: - schema: type: string format: uuid in: path name: connectionId required: true description: The ID of the Convex Connection to rotate credentials for. responses: '200': description: Default Response content: application/json: schema: type: object properties: appConnection: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true version: type: number default: 1 orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time isPlatformManagedCredentials: type: boolean default: false nullable: true gatewayId: type: string format: uuid nullable: true projectId: type: string nullable: true isAutoRotationEnabled: type: boolean default: false gatewayPoolId: type: string format: uuid nullable: true rotation: type: object properties: lastRotationMessage: type: string nullable: true description: The message from the last rotation attempt. rotationInterval: type: number description: The interval in days between credential rotations. nextRotationAt: type: string format: date-time nullable: true description: The next scheduled rotation time. rotationStatus: type: string enum: - success - failed description: The status of the last rotation attempt. rotateAtUtc: type: object properties: hours: type: number description: The hour (0-23) at which to rotate. minutes: type: number description: The minute (0-59) at which to rotate. required: - hours - minutes additionalProperties: false description: The UTC time of day at which rotation should occur. required: - rotationInterval - rotationStatus - rotateAtUtc additionalProperties: false description: The credential rotation configuration, if configured. credentialsHash: type: string project: type: object properties: name: type: string id: type: string type: type: string slug: type: string required: - name - id - type - slug additionalProperties: false nullable: true app: type: string enum: - convex method: type: string enum: - personal-access-token credentials: type: object properties: instanceUrl: type: string format: uri description: The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided. additionalProperties: false required: - id - name - orgId - createdAt - updatedAt - app - method - credentials additionalProperties: false title: Convex (Personal Access Token) required: - appConnection 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