Skip to content
Mengi CloudMengi Cloud Docs

List Secrets

GET
/secrets
curl --request GET \
  --url https://api.mengi.cloud/secrets

List secrets in the active organization’s namespace (defaults to the user’s personal org). If deployment_id is provided, the deployment’s org namespace is listed and the result contains the secrets that deployment can consume: its own deployment-scoped secrets plus the org-wide (unscoped) ones. Other deployments’ scoped secrets are excluded.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
deployment_id
Any of:
string format: uuid
organization_id
Any of:
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SecretListResponse
object
secrets
required
Secrets
Array<object>
SecretResponse
object
name
required
Name
string
key
required
Key
string
deployment_id
Any of:
string
database_id
Any of:
string
organization_id
Any of:
string
total
required
Total
integer
Examplegenerated
{
  "secrets": [
    {
      "name": "example",
      "key": "example",
      "deployment_id": "example",
      "database_id": "example",
      "organization_id": "example"
    }
  ],
  "total": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}