List Secrets

Deprecated

GET/v5/sgp/secrets

List secret metadata for the account. Values are never returned.

Query ParametersExpand Collapse

ending_before: optional string

limit: optional number

maximum10000

minimum1

sort_by: optional string

sort_order: optional SortOrder

One of the following:

"asc"

"desc"

starting_after: optional string

ReturnsExpand Collapse

has_more: boolean

Whether there are more items left to be fetched.

items: array of CloudSecret { id, account_id, cloud_secret_path, 7 more }

id: string

The unique identifier of the entity.

account_id: string

The ID of the account that owns the given entity.

cloud_secret_path: string

Full path in the cloud secret store.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

key: string

Secret name, e.g. OPENAI_API_KEY.

description: optional string

Optional human-readable description of the secret.

object: optional "sgp_cloud_secret"

updated_at: optional string

Timestamp of last update.

formatdate-time

updated_by: optional string

User who last updated the secret.

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: optional number

The maximum number of items to return.

object: optional "list"

List Secrets

curl https://api.egp.scale.com/v5/sgp/secrets \
    -H "x-api-key: $SGP_API_KEY"

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "cloud_secret_path": "cloud_secret_path",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "key": "key",
      "description": "description",
      "object": "sgp_cloud_secret",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "updated_by": "updated_by"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Returns Examples

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "cloud_secret_path": "cloud_secret_path",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "key": "key",
      "description": "description",
      "object": "sgp_cloud_secret",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "updated_by": "updated_by"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}