Skip to main content
POST
/
api
/
svc
/
v1
/
secrets
List Secrets
curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 10,
  "offset": 0,
  "secretFqns": [
    "<string>"
  ],
  "secretGroupId": "<string>",
  "withValue": false
}
'
{
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
secretFqns
string[]

Array of FQNs

​
secretGroupId
string

Secret Group Id of the secret gourp.

​
withValue
boolean
default:false

Whether to include the secret values in the response. Defaults to false.

Response

Returns the secrets associated with a user filtered with optional parameters passed in the body.

​
data
Secret · object[]
required

Array of Secrets

​
pagination
Pagination · object
required

Pagination Information