POST /v1/apps/secrets

Create or replace a secret in the secret store.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
name String Yes

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

expand[] Array No

Specifies which fields in the response should be expanded.

payload String Yes

The plaintext secret value to be stored.

scope Object Yes

Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

scope.user String No
scope.type String Yes

Possible values:

  • "account"
  • "user"
expires_at Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.