PUT
/
api
/
svc
/
v1
/
secret-groups
/
{id}
curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/secret-groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "secrets": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "data": {
    "id": "<string>",
    "fqn": "<string>",
    "name": "<string>",
    "tenantName": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "associatedSecrets": [
      {
        "id": "<string>",
        "fqn": "<string>",
        "name": "<string>",
        "secretGroupId": "<string>",
        "value": "<string>",
        "createdBySubject": {
          "subjectId": "<string>",
          "subjectType": "user",
          "subjectSlug": "<string>",
          "subjectDisplayName": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "secretVersions": [
          {
            "id": "<string>",
            "fqn": "<string>",
            "value": "<string>",
            "version": 123,
            "secret": {},
            "secretId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "activeDeploymentsCount": 123,
        "createdBy": "<string>"
      }
    ],
    "integrationId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Secret Id of the secret group.

Body

application/json

Response

200
application/json

Returns the updated secret group without associated secrets.

The response is of type object.

PUT
/
api
/
svc
/
v1
/
secret-groups
/
{id}
curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/secret-groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "secrets": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "data": {
    "id": "<string>",
    "fqn": "<string>",
    "name": "<string>",
    "tenantName": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "associatedSecrets": [
      {
        "id": "<string>",
        "fqn": "<string>",
        "name": "<string>",
        "secretGroupId": "<string>",
        "value": "<string>",
        "createdBySubject": {
          "subjectId": "<string>",
          "subjectType": "user",
          "subjectSlug": "<string>",
          "subjectDisplayName": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "secretVersions": [
          {
            "id": "<string>",
            "fqn": "<string>",
            "value": "<string>",
            "version": 123,
            "secret": {},
            "secretId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "activeDeploymentsCount": 123,
        "createdBy": "<string>"
      }
    ],
    "integrationId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Secret Id of the secret group.

Body

application/json

Response

200
application/json

Returns the updated secret group without associated secrets.

The response is of type object.