Skip to main content
PATCH
/
api
/
v1
/
workspace
/
{workspaceId}
cURL
curl --request PATCH \
  --url https://us.infisical.com/api/v1/workspace/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "autoCapitalization": true,
  "hasDeleteProtection": true,
  "slug": "<string>",
  "secretSharing": true,
  "showSnapshotsLegacy": true,
  "defaultProduct": "secret-manager",
  "secretDetectionIgnoreValues": [
    "<string>"
  ]
}
'
{
  "workspace": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "slug": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "defaultProduct": "<string>",
    "autoCapitalization": false,
    "version": 1,
    "upgradeStatus": "<string>",
    "pitVersionLimit": 10,
    "kmsCertificateKeyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "auditLogsRetentionDays": 123,
    "hasDeleteProtection": false,
    "secretSharing": true,
    "showSnapshotsLegacy": false,
    "secretDetectionIgnoreValues": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

An access token in Infisical

Path Parameters

​
workspaceId
string
required

The ID of the project to update.

Body

application/json
​
name
string

The new name of the project.

Maximum string length: 64
​
description
string

An optional description label for the project.

Maximum string length: 256
​
autoCapitalization
boolean

Disable or enable auto-capitalization for the project.

​
hasDeleteProtection
boolean

Enable or disable delete protection for the project.

​
slug
string

An optional slug for the project. (must be unique within the organization)

Maximum string length: 64
​
secretSharing
boolean

Enable or disable secret sharing for the project.

​
showSnapshotsLegacy
boolean

Enable or disable legacy snapshots for the project.

​
defaultProduct
enum<string>

The default product in which the project will open

Available options:
secret-manager,
cert-manager,
kms,
ssh,
secret-scanning,
pam
​
secretDetectionIgnoreValues
string[]

The list of secret values to ignore for secret detection.

Response

Default Response

​
workspace
object
required