Skip to main content
POST
/
api
/
svc
/
v1
/
secret-groups
Create Secret Group
curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/secret-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "integrationId": "<string>",
  "secrets": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "data": {
    "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": "<unknown>",
            "secretId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "activeDeploymentsCount": 123,
        "createdBy": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "fqn": "<string>",
    "integrationId": "<string>",
    "manifest": {},
    "createdBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Name of the secret group.

​
integrationId
string
required

Id of the provider integration.

​
secrets
SecretInput · object[]
required

The secrets to be associated with the secret group

Response

Returns the created secret group without the associated secrets.

​
data
SecretGroup · object
required

Secret Group