Swagger Petstore - OpenAPI 3.0
GET/v1/apps/secrets/find

Find a secret by name and scope

Finds a secret in the secret store by name and scope. Secrets are scoped to provide permission control — requests from UI extensions can only access account-scoped secrets or secrets scoped to their own user. Returns the secret object if found.

3 parameters
expandarray<string>optional

Specifies which fields in the response should be expanded.

namestringrequired

A name for the secret that is unique within the scope.

scopeobjectrequired

Specifies the scoping of the secret. Must be an object with type set to account or user, and optionally a user field for user-scoped secrets.

2 status codes
200Returns the secret object with its name, scope, creation time, expiry, and plaintext payload.
createdintegerrequired

Time at which the object was created. Measured in seconds since the Unix epoch.

deletedbooleanoptional

If true, indicates that this secret has been deleted

expires_atintegeroptional

The Unix timestamp for the expiry time of the secret, after which the secret deletes.

idstringrequired

Unique identifier for the object.

livemodebooleanrequired

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

namestringrequired

A name for the secret that's unique within the scope.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:apps.secret
payloadstringoptional

The plaintext secret value to be stored.

scopeobjectrequired
defaultError response.
errorobjectrequired

Error handling

Both name and scope are required. scope must be an object with a type field set to either account or user. If type is user, the user field must also be provided. name must be unique within the specified scope.