Delete a Secret

POST / v1 / apps / secrets / delete

Deletes a secret from the secret store by name and scope.

Parameters

name string Required A name for the secret that’s unique within the scope.
scope object Required Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Returns

Returns the deleted secret object.

Response

{ "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "deleted": true}

Find a Secret

GET / v1 / apps / secrets / find

Finds a secret in the secret store by name and scope.

Parameters

name string Required A name for the secret that’s unique within the scope.
scope object Required Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Returns

Returns a secret object.

Response

{ "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "created": 1680209063, "expires_at": null, "livemode": false, "name": "my-api-key", "scope": { "type": "account" }}

Set a Secret

POST / v1 / apps / secrets

Create or replace a secret in the secret store.

Parameters

name string Required A name for the secret that’s unique within the scope.
payload string Required The plaintext secret value to be stored.
scope object Required Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
expires _ at timestamp The Unix timestamp for the expiry time of the secret, after which the secret deletes.

Returns

Returns a secret object.

Response

{ "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "created": 1680209063, "expires_at": null, "livemode": false, "name": "my-api-key", "scope": { "type": "account" }}