Skip to main content
GET
/
api
/
svc
/
v1
/
secrets
/
{id}
Get a secret
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/secrets/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "fqn": "<string>",
    "name": "<string>",
    "secretGroupId": "<string>",
    "value": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>",
      "subjectPatName": "<string>",
      "subjectControllerName": "<string>",
      "subjectExternalIdentitySlug": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secretVersions": [
      {
        "id": "<string>",
        "fqn": "<string>",
        "value": "<string>",
        "version": 123,
        "secret": null,
        "secretId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "activeDeploymentsCount": 123,
    "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

Unique identifier of the secret.

Response

The requested secret.

​
data
Secret · object
required

Secret