v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Secret References

List All Secret References

An endpoint for listing secret references

get/v1/projects/{projectId}/secret-references

Path parameters

projectIdstring uuid required

Query parameters

secretReferenceTypesstring[]

Optional filter for secret reference types. If not provided, only PASSWORD types will be returned

providersstring[]

Optional filter for providers. This is applicable only for non-PASSWORD secret reference types

{"stackTrail":"paths:/v1/projects/{projectId}/secret-references:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Page number (0-indexed)

{"stackTrail":"paths:/v1/projects/{projectId}/secret-references:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Number of records per page (from 1 to 100)

Response

Secret references have been retrieved

pageinteger

The 0-indexed page number of the returned results.

sizeinteger

The size of each page of results.

totalinteger

Total number of available results across all pages.

Example response

{
  "page": 1,
  "results": [
    {
      "name": "Data-Productivity-Cloud-secret-name",
      "secretKey": "aws-secret-key",
      "secretName": "aws-secret-name",
      "type": "PASSWORD",
      "vaultType": "AWS"
    }
  ],
  "size": 50,
  "total": 472
}