Skip to main content
POST
/
api
/
v1
/
app-connections
/
redis
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/redis \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "username-and-password",
  "credentials": {
    "host": "<string>",
    "port": 123,
    "username": "<string>",
    "password": "<string>",
    "sslRejectUnauthorized": true,
    "sslEnabled": true,
    "sslCertificate": "<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": "redis",
    "method": "username-and-password",
    "credentials": {
      "host": "<string>",
      "port": 123,
      "username": "<string>",
      "sslEnabled": true,
      "sslRejectUnauthorized": true,
      "sslCertificate": "<string>"
    }
  }
}
Check out the configuration docs for Redis Connections to learn how to obtain the required credentials.

Body

application/json
name
string
required

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

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

The method used to authenticate with Redis.

Available options:
username-and-password
credentials
object
required

The credentials used to connect with Redis.

description
string | null

An optional description for the Redis Connection.

Maximum length: 256
projectId
string

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

isPlatformManagedCredentials
boolean

Not supported for Redis Connections.

gatewayId

Not supported for Redis Connections.

Response

Default Response

appConnection
object
required