OMomni
Model Git configuration

Get Git configuration

Retrieve the Git configuration for a shared model, or a shared extension model in the Develop independently branch workflow that owns its own Git repository, separate from its parent model's.

get/v1/models/{modelId}/git

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/git
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

The unique identifier of the shared model, or a shared extension model in the Develop independently branch workflow.

Query parameters

include'webhookSecret'

Comma-separated list of additional fields to include in the response.

  • webhookSecret - Include the webhook secret in the response

Response

Git configuration retrieved successfully

authMethod'ssh' | 'https_token'

Authentication method. ssh for deploy key, https_token for deploy token/PAT.

cloneUrlstring

Clone URL of the git repository (SSH or HTTPS)

baseBranchstring

The target branch for Omni pull requests.

branchPerPullRequestboolean

If true, all pull requests will create a branch in Omni, even those created outside of the tool.

gitFollowerboolean

If true, the shared model is read-only and can only be updated by merging pull requests to the base branch.

gitServiceProvider'github' | 'gitlab' | 'azure_devops' | 'bitbucket'

The git provider type.

  • github - GitHub
  • gitlab - GitLab
  • azure_devops - Azure DevOps
  • bitbucket - Bitbucket
modelPathstring nullable

Path to model files in the repository.

requirePullRequest'always' | 'users-only' | 'never'

Controls when pull requests are required for changes:

  • always - Required for all changes
  • users-only - Required only for user-initiated changes
  • never - Never required
sshUrlstring

Deprecated. Use cloneUrl instead. SSH URL of the git repository.

webUrlstring nullable

Custom web URL for the git repository, or null if not set.

webhookSecretstring

Webhook secret for signature verification. Only included if requested via ?include=webhookSecret.

webhookUrlstring

Webhook URL to configure in your git provider.

Example response

{
  "authMethod": "ssh",
  "cloneUrl": "git@github.com:org/repo.git",
  "baseBranch": "main",
  "gitServiceProvider": "github",
  "modelPath": "omni/blobs_r_us",
  "requirePullRequest": "users-only",
  "sshUrl": "git@github.com:org/repo.git",
  "webUrl": "https://github.com/org/repo",
  "webhookUrl": "https://app.omni.co/api/webhooks/model/..."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.