Skip to main content
POST
/
api
/
v1
/
app-connections
/
heroku
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/heroku \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "auth-token",
  "credentials": {
    "authToken": "<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": "heroku",
    "method": "auth-token",
    "credentials": {}
  }
}
Heroku OAuth Connections must be created through the Infisical UI. Check out the configuration docs for Heroku OAuth Connections for a step-by-step guide.

Body

application/json
  • Option 1
  • Option 2
name
string
required

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

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

The method used to authenticate with Heroku.

Available options:
auth-token
credentials
object
required

The credentials used to connect with Heroku.

description
string | null

An optional description for the Heroku Connection.

Maximum length: 256
projectId
string

The ID of the project to create the Heroku Connection in.

isPlatformManagedCredentials
boolean

Not supported for Heroku Connections.

gatewayId

Not supported for Heroku Connections.

Response

Default Response

appConnection
object
required
  • Option 1
  • Option 2