Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-ssl-pinning`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/ssl-pinning/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

bun add @capgo/capacitor-ssl-pinning
bunx cap sync

Import

import { SSLPinning } from '@capgo/capacitor-ssl-pinning';

API Overview

`getConfiguration`

Returns the active native configuration visible to the plugin.

import { SSLPinning } from '@capgo/capacitor-ssl-pinning';

await SSLPinning.getConfiguration();

Type Reference

`SSLPinningConfigurationState`

Static SSL pinning configuration currently visible to the plugin.

export interface SSLPinningConfigurationState {
  /**
   * Whether at least one certificate is configured for native pinning.
   */
  configured: boolean;

  /**
   * Certificate paths from `capacitor.config.*` relative to the app root.
   */
  certs: string[];

  /**
   * Fully-qualified URLs that should bypass SSL pinning.
   */
  excludedDomains: string[];
}

`PluginVersionResult`

Plugin version payload.

export interface PluginVersionResult {
  /**
   * Version identifier returned by the platform implementation.
   */
  version: string;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

If you are using Getting Started to plan security and compliance, connect it with Using @capgo/capacitor-ssl-pinning for the native capability in Using @capgo/capacitor-ssl-pinning, Encryption for the implementation detail in Encryption, Compliance for the implementation detail in Compliance, Capgo Security Scanner for the product workflow in Capgo Security Scanner, and Capgo Security for the product workflow in Capgo Security.