Create an SCM App installation intent

POST/v1/scm-installations/install-intentsCreate 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.

Request body

application/json

object

providerstringrequired

one of "github"

repositorystring

pattern ^[\w.-]+\/[\w.-]+$

workspaceIdstringrequired

pattern ^(wksp_)?([cC][^\s-]{8,}|[a-z0-9]+)$

Example request

{
  "provider": "github",
  "repository": "string",
  "workspaceId": "string"
}

Responses

object

dataobjectrequired

Show child attributes

accountLoginstring

alreadyLinkedboolean

hintstring

installUrlstring · urirequired

providerstringrequired

one of "github"

typestringrequired

const "install-intent"

workspaceIdstringrequired

pattern ^(wksp_)([cC][^\s-]{8,}|[a-z0-9]+)$

Example response

{
  "data": {
    "accountLogin": "string",
    "alreadyLinked": true,
    "hint": "string",
    "installUrl": "https://example.com",
    "provider": "github",
    "type": "install-intent",
    "workspaceId": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

curl -X POST 'https://api.prisma.io/v1/scm-installations/install-intents' \
  -H 'Content-Type: application/json' \
  -d '{"provider":"github","repository":"string","workspaceId":"string"}'

const response = await fetch('https://api.prisma.io/v1/scm-installations/install-intents', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"provider":"github","repository":"string","workspaceId":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/scm-installations/install-intents', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"provider\":\"github\",\"repository\":\"string\",\"workspaceId\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.prisma.io/v1/scm-installations/install-intents",
    headers={"Content-Type": "application/json"},
    data='{"provider":"github","repository":"string","workspaceId":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"provider":"github","repository":"string","workspaceId":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.prisma.io/v1/scm-installations/install-intents", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/scm-installations/install-intents");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"provider\":\"github\",\"repository\":\"string\",\"workspaceId\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/scm-installations/install-intents"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"provider\":\"github\",\"repository\":\"string\",\"workspaceId\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/scm-installations/install-intents")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"provider\":\"github\",\"repository\":\"string\",\"workspaceId\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.prisma.io/v1/scm-installations/install-intents");
request.Content = new StringContent("{\"provider\":\"github\",\"repository\":\"string\",\"workspaceId\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "accountLogin": "string",
    "alreadyLinked": true,
    "hint": "string",
    "installUrl": "https://example.com",
    "provider": "github",
    "type": "install-intent",
    "workspaceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets