Create a secret or variable

post

https://{tenant}.katalon.io/v2/sh/params

Creates one secret or one variable in the project. Send one request for
each entry.

Secrets and variables share one set of keys in the project. If the
project already has an entry with the same key, the call returns 409.
To replace a value, delete the existing entry, then create it again.

A project entry takes precedence over an account default that has the
same key.

The response never includes a secret value. For a secret, it includes
masked: true. For a variable, it includes the stored value.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

kind

string

enum

required

SECRET for a sensitive value. The value is encrypted and never returned
by these operations. VARIABLE for a readable value. The value is
returned as plain text. You cannot change the kind after you create the entry.

Allowed:

logicalKey

string

required

^[A-Za-z0-9_.\-]{1,128}$

The entry key: 1 to 128 letters, digits, underscores, dots, or hyphens.
Keys are case-sensitive.

value

string

required

The value to store. For a secret, the service encrypts it and does not return it.

Headers

x-account-id

uuid

Account UUID for the requested project. Optional. If you send it, it must be the project's account.

x-organization-id

int64

Organization ID, if supplied. It must match the project's organization.

x-project-id

int64

required

≥ 1

Numeric project ID within the account. Send exactly one positive value on every request.

Responses

401

Authentication failed. The response body can differ from a ParameterError.

default

The request could not be completed. Check the response status and message before you retry.

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

201The entry was created.

400The request is not valid. For example, the key does not match the allowed pattern, or the x-project-id header is not one positive number. Errors in the request body return a ParameterError with the code invalid_request. A header error can return a different body.

403Access was denied. Check that your key's user has access to the account and project, and that the entry belongs to the project in x-project-id. An entry-level denial returns a ParameterError with the code forbidden. Other denials can return a different body.

409An entry with the same key already exists in the project.