Gable Docs

Docs

• Create a new action: Create a new action
• Delete an existing action: Delete an existing action
• Get all actions: Get all actions
• This is a fake path added just so the schemas are generated into code. It will be removed from the OAS after type generation, before documentation generation.: This is a fake path added just so the schemas are generated into code. It will be removed from the OAS after type generation, before documentation generation.
• Update an existing action: Update an existing action
• Get all api keys: Get all api keys
• Get SCA Prime S3 URL: Get presigned S3 URL to SCA Prime artifact bucket containing the symbol artifact for the given library and scaPrimeHash
• Gets temporary aws code artfact creditial for pip: Gets temporary aws code artfact creditial for pip
• Gets temporary npm credentials: Gets temporary npm credentials
• Create a new changelog event: Create a new changelog event
• Get changelog count: Get changelog count
• Get changelog filters available: Get changelog filters available
• Get the changelog: Get the changelog
• Delete a component by id: Delete a component by id
• Get a component by id: Get a component by id
• Get all components: Get all components
• Get all versions of a component: Get all versions of a component
• Get component diff between two versions: Compare two versions of a component's lineage. Returns a high-level summary of all path-level changes.
• Get component merge history: Get a component's MERGE_TO_MAIN version history with per-version diff metrics and downstream breakage indicators, ordered newest-first.
• Get path diff between two versions: Compare a single path between two versions of a component. Returns field-level and code-flow detail.
• Update component metadata: Update a component's metadata
• Get components history: Get components run history entries, optionally filtered by trigger, branch, commit, namespace, and time range.
• Get components history filters: Get components history filters
• Get v0config: Get config by type, language, repo and optional version. Returns the latest config if version is not specified.
• Get contract Constraints: Get contract Constraints
• Create a contract: Create a contract
• Create a contract enforcement level: create a contract enforcement level
• Create a new subscription for a contract: Create a new subscription for a contract
• Delete a contract by ID: Delete a contract by ID
• Delete a subscription for a contract: Delete a subscription for a contract
• Get a contract by id: Get a contract by id
• Get a contract enforcement level by id: Get a contract enforcement level by id
• Get a contract subscription by id: Get a contract subscription by id
• Get all available contract namespaces: Get all available contract namespaces
• Get all contract subscriptions: Get all contract subscriptions
• Get all contracts: Get all contracts
• Get contracts count: Get contracts count
• Get the activity events for a contract: Get the activity events for a contract
• Get the contract by darn: Get the contract by darn
• Get the contract by data asset name: Get the contract by data asset name
• Get the violation status of a contract by id: Get the violation status of a contract by id
• Update a contract enforcement level by id: Update a contract enforcement level by id
• Update a contract subscription: Update a contract subscription
• Update a contract's stage: Update a contract's stage
• Validate a contract: Validate a contract
• Get all components: Get all components
• Check if the asset associated with the contract is compliant: Check if the asset associated with the contract is compliant
• Check list of data assets for contract violations: Check list of data assets for contract violations
• Check list of data assets for contract violations: Check list of data assets for contract violations
• Check list of S3 data assets for contract violations: Check list of S3 data assets for contract violations
• Check multiple assets for contract compliance: Check if multiple assets associated with a contract are compliant
• Create a data asset: Create a data asset
• Create profile for a data asset: Create profile for a data asset
• Creates or updates data assets: Creates or updates data assets
• Delete a data asset by id: Delete a data asset by id
• Deletes data assets: Deletes data assets
• Get a data asset by id: Get a data asset by id
• Get all data assets: Get all data assets
• Get data assets by a list of DARNs: Get data assets by a list of DARNs
• Get data assets count: Get data assets count
• Infer a contract from a data asset: Infer a contract from a data asset
• Ingest a data asset from a schema: Ingest a data asset from a schema
• Register an S3 data asset: Register an S3 data asset
• Register data assets: Register data assets
• Register sca metadata for a data asset version: Register sca metadata for a data asset version
• Gable version endpoint: Gable version endpoint
• Ping Gable: Ping Gable
• Submit a defect report: Submit a defect report from the product UI
• Create Lineage Events: Create Lineage Events
• Add path to component.: Add a new path to a CODE component.
• Create a new cross-service edge.: Create a new cross-service edge.
• Delete a cross-service edge.: Delete a cross-service edge by ID.
• Delete a path from a component.: Delete a path from a CODE component.
• Get a cross-service edge by ID.: Get a cross-service edge by ID.
• Get component detail.: Get full component detail. For CODE components, paths include inline ingress/egress boundary data for round-trip editing. For DATA_STORE components, the schema field list is returned.
• Get component versions.: Get version history for a component.
• List components.: List components with optional search and type filtering.
• List cross-service edges.: List cross-service edges.
• List field pairs for a component.: List field pairs on a component for the field-level focused views.
• Update a cross-service edge.: Update a cross-service edge by ID. Replaces the entire edge definition.
• Update a path on a component.: Update a path on a CODE component. Internally creates a BYO_PATH_DELETED event for the old path and a BYO_PATH_ADDED event for the new path, preserving the projection engine's overlay model.
• Introduction
• Export lineage: Export lineage
• Compute a measurement report on the fly: Fetches lineage data for the specified component versions, runs the measurement comparison, and returns the result without persisting.
• Create a filter set: Create a measurement-report filter set for a ground-truth component.
• Delete a filter set: Delete a measurement-report filter set.
• List filter sets: List measurement-report filter sets for a ground-truth component.
• Update a filter set: Update a measurement-report filter set.
• Get notifications: Get notifications
• Get notifications count: Get notifications count
• Post v0config: Create a config - config
• Get status of a sca run: Get status of a sca run
• Post SCA results: Post SCA results
• Resolve SCA config and run ID: Resolve SCA config and a canonical run ID for a future upload
• Configure (create or update) an SSO integration in Gable: Configure (create or update) an SSO integration in Gable
• Deletes a user: Deletes a user from Gable
• Get the SAML integration details: Get the details required to create a SAML integration for Gable in an IdP
• Gets the configuration of the existing SSO integration: Gets the configuration of the existing SSO integration, returns 404 if SSO is not currently configured
• Gets the details of a Gable user: Gets the details of a Gable user by their email address. Users are automatically created in Gable the first time they log in. Use PATCH /v0/settings/user to update a user's details.
• Gets the list of Gable users: Gets the list of Gable users
• Invites a user: Invites a user to Gable
• Remove the existing SSO integration in Gable: Remove the existing SSO integration in Gable
• Update a user: Update a user
• Delete Slack integration: Delete Slack integration
• Get Slack channels for workspace: Get Slack channels for workspace
• Get the generated Slack install URL: Get the generated Slack install URL
• Post a test message to the slack channel: Post a test message to the slack channel
• Create a telemetry data point: Create a telemetry data point for long term storage in the telemetry table
• Create a webhook endpoint: Create a webhook endpoint
• Delete the existing webhook: Delete the existing webhook
• Get webhooks endpoints: Get webhooks endpoints
• Post a test message to the webhook: Post a test message to the webhook
• Update a webhook: Update a webhook
• Data Access
• High Availability & Disaster Recovery
• Role Based Access Control
• Security and Compliance
• gable auth
• gable auth key
• gable auth npm
• gable auth pip
• gable contract
• gable contract bulk-update-enforcement-levels
• gable contract publish
• gable contract validate
• gable data-asset
• gable data-asset check
• gable data-asset create-contract
• gable data-asset delete
• gable data-asset list
• gable data-asset register
• gable data-asset show
• CLI Reference
• gable lineage
• gable lineage compare
• gable lineage component
• gable lineage component get
• gable lineage component list
• gable lineage component path
• gable lineage component path add
• gable lineage component path generate
• gable lineage component path get
• gable lineage component path list
• gable lineage component path remove
• gable lineage component path update
• gable lineage component versions
• gable lineage datastore
• gable lineage datastore add
• gable lineage datastore generate
• gable lineage datastore get
• gable lineage datastore list
• gable lineage datastore update
• gable lineage edge
• gable lineage edge add
• gable lineage edge generate
• gable lineage edge get
• gable lineage edge list
• gable lineage edge remove
• gable lineage edge update
• gable lineage export
• gable lineage scan
• gable lineage upload
• gable ping
• gable ui
• Approvals: Review and approve a component's lineage version to establish a trusted baseline
• Comparing Lineage Versions (Snapshot Diffing): Compare component versions to understand how lineage changed between scans, merges, or pull requests
• Merge / Impact Reports: Per-merge reports showing what changed and which upstream and downstream dependencies are affected
• Coverage & Completeness: Where lineage gaps come from, how to close them, and how Gable monitors coverage
• Dependencies (Cross-Service Edges): Create and manage cross-service edges that connect lineage between services and data stores
• Field Mappings & Overrides: Review, suppress, and override lineage paths and field mappings within a service
• Services & Data Components: How services and data stores are represented in Gable, and how to add, edit, and delete data store components
• CLI Changelog: CLI updates
• Product Changelog: Product updates and announcements
• Guide: Auto-publish Data Store Schemas from Avro and Protobuf: Automatically publish data store schema components whenever schema files change in your repository
• Support
• API Keys and Endpoints
• Single Sign-On (SSO)
• Update Profile
• User Management
• Generating Compliance Evidence: Use lineage to answer where regulated data comes from, what computes it, and who consumes it
• Tracing Data Lineage: Follow a field across services and data stores in the Lineage Explorer
• Exporting Lineage: Export field lineage to CSV from the Lineage Explorer, or export full lineage data via the API
• Sensitive Data: Classify sensitive and regulated fields and track them across your lineage graph
• Understanding the Source of Lineage Issues: How Gable's lineage responds to code changes, and how to tell a real change from a detection gap
• Introduction: What Gable does and how to use it.

OpenAPI Specs

• bundled
• openapi