Update

Update the specified Redis Credentials Rotation.

PATCH /api/v2/secret-rotations/redis-credentials/{rotationId}

cURL

cURL

curl --request PATCH \
  --url https://us.infisical.com/api/v2/secret-rotations/redis-credentials/{rotationId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isAutoRotationEnabled": true,
  "rotationInterval": 2
}
'

200

{
  "secretRotation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "rotationInterval": 123,
    "rotationStatus": "<string>",
    "lastRotationAttemptedAt": "2023-11-07T05:31:56Z",
    "lastRotatedAt": "2023-11-07T05:31:56Z",
    "connection": {
      "app": "redis",
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "environment": {
      "slug": "<string>",
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "projectId": "<string>",
    "folder": {
      "id": "<string>",
      "path": "<string>"
    },
    "rotateAtUtc": {
      "hours": 11.5,
      "minutes": 29.5
    },
    "type": "redis-credentials",
    "parameters": {
      "permissionScope": "<string>",
      "passwordRequirements": {
        "length": 125.5,
        "required": {
          "digits": 1,
          "lowercase": 1,
          "uppercase": 1,
          "symbols": 1
        },
        "allowedSymbols": "<string>"
      }
    },
    "secretsMapping": {
      "username": "<string>",
      "password": "<string>"
    },
    "description": "<string>",
    "isAutoRotationEnabled": true,
    "activeIndex": 0,
    "lastRotationJobId": "<string>",
    "nextRotationAt": "2023-11-07T05:31:56Z",
    "isLastRotationManual": true,
    "lastRotationMessage": "<string>"
  }
}

Check out the configuration docs for Redis Credentials Rotations to learn how to obtain the required parameters.

Path Parameters

rotationId · string<uuid> · required

The ID of the Redis Credentials Rotation to be updated.

Body

application/json

name · string

The updated name of the Redis Credentials Rotation. Must be slug-friendly.

Required string length: 1 - 64

description · string | null

The updated description of the Redis Credentials Rotation.

Maximum string length: 256

isAutoRotationEnabled · boolean

Whether secrets should be automatically rotated when the specified rotation interval has elapsed.

rotationInterval · number

The updated interval, in days, to automatically rotate secrets.

Required range: x >= 1

rotateAtUtc · object

The updated hours and minutes rotation should occur at in UTC.

Show child attributes

parameters · object

Show child attributes

secretsMapping · object

Show child attributes

Response

200

application/json

Default Response

secretRotation · object · required

Show child attributes