Skip to main content
POST
/
api
/
v1
/
app-connections
/
github-radar
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/github-radar \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "github-app",
  "credentials": {
    "code": "<string>",
    "installationId": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "isPlatformManagedCredentials": true,
  "gatewayId": "<any>"
}'
{
  "appConnection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "version": 1,
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isPlatformManagedCredentials": false,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "credentialsHash": "<string>",
    "project": {
      "name": "<string>",
      "id": "<string>",
      "type": "<string>",
      "slug": "<string>"
    },
    "app": "github-radar",
    "method": "github-app",
    "credentials": {}
  }
}
GitHub Radar Connections must be created through the Infisical UI. Check out the configuration docs for GitHub Radar Connections for a step-by-step guide.

Body

application/json
name
string
required

The name of the GitHub Radar Connection to create. Must be slug-friendly.

Required string length: 1 - 64
method
enum<string>
required

The method used to authenticate with GitHub Radar.

Available options:
github-app
credentials
object
required

The credentials used to connect with GitHub Radar.

description
string | null

An optional description for the GitHub Radar Connection.

Maximum length: 256
projectId
string

The ID of the project to create the GitHub Radar Connection in.

isPlatformManagedCredentials
boolean

Not supported for GitHub Radar Connections.

gatewayId

Not supported for GitHub Radar Connections.

Response

Default Response

appConnection
object
required