[Experimental]

Create an SCM App installation intent

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Creates an installation intent for the given workspace. If an existing installation can be proven to belong to the caller it is linked immediately (alreadyLinked); otherwise the response carries a URL the user opens to install the SCM app. Pass repository (owner/name) so an installation that already covers it but cannot be linked automatically is detected and explained in hint. Currently only github is supported.

post/v1/scm-installations/install-intents

Request

  • Base URL: https://api.prisma.io
  • URL: https://api.prisma.io/v1/scm-installations/install-intents
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.prisma.io/authorize, token URL https://auth.prisma.io/token, scopes: workspace:admin, offline_access)
    • HTTP bearer

Request body

provider'github' required
workspaceIdstring required
repositorystring

Response

Installation intent created. The installUrl is single-use and time-limited.

Changes

No recorded changes to this operation across all 1 revision of this API.