Create vault entry

curl --request POST \
  --url https://api.cloudcruise.com/vault \
  --header 'Content-Type: application/json' \
  --header 'cc-key: <api-key>' \
  --data '{
  "permissioned_user_id": "<string>",
  "user_name": "<string>",
  "password": "<string>",
  "domain": "<string>",
  "tfa_secret": "<string>",
  "user_alias": "<string>",
  "persist_session_storage": true,
  "persist_local_storage": true,
  "persist_cookies": true,
  "allow_multiple_sessions": true,
  "max_concurrency": 123,
  "prevent_concurrency_during_login": true,
  "expiry_time_from_last_use": "<string>",
  "expiry_time_from_session_data_set": "<string>",
  "tfa_method": "AUTHENTICATOR",
  "proxy": {
    "enable": true,
    "target_ip": "<string>"
  }
}'

{
  "permissioned_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_name": "<string>",
  "password": "<string>",
  "domain": "<string>",
  "user_alias": "<string>",
  "tfa_secret": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_storage": {},
  "local_storage": {},
  "cookies": [
    {
      "name": "<string>",
      "value": "<string>",
      "domain": "<string>",
      "path": "<string>",
      "expirationDate": 123,
      "httpOnly": true,
      "hostOnly": true,
      "secure": true,
      "session": true,
      "storeId": "<string>",
      "sameSite": "<string>"
    }
  ],
  "persist_local_storage": true,
  "persist_cookies": true,
  "persist_session_storage": true,
  "allow_multiple_sessions": true,
  "max_concurrency": 123,
  "prevent_concurrency_during_login": true,
  "expiry_time_from_last_use": "<string>",
  "expiry_time_from_session_data_set": "<string>",
  "tfa_method": "AUTHENTICATOR"
}

POST

vault

Create vault entry

curl --request POST \
  --url https://api.cloudcruise.com/vault \
  --header 'Content-Type: application/json' \
  --header 'cc-key: <api-key>' \
  --data '{
  "permissioned_user_id": "<string>",
  "user_name": "<string>",
  "password": "<string>",
  "domain": "<string>",
  "tfa_secret": "<string>",
  "user_alias": "<string>",
  "persist_session_storage": true,
  "persist_local_storage": true,
  "persist_cookies": true,
  "allow_multiple_sessions": true,
  "max_concurrency": 123,
  "prevent_concurrency_during_login": true,
  "expiry_time_from_last_use": "<string>",
  "expiry_time_from_session_data_set": "<string>",
  "tfa_method": "AUTHENTICATOR",
  "proxy": {
    "enable": true,
    "target_ip": "<string>"
  }
}'

{
  "permissioned_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_name": "<string>",
  "password": "<string>",
  "domain": "<string>",
  "user_alias": "<string>",
  "tfa_secret": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "session_storage": {},
  "local_storage": {},
  "cookies": [
    {
      "name": "<string>",
      "value": "<string>",
      "domain": "<string>",
      "path": "<string>",
      "expirationDate": 123,
      "httpOnly": true,
      "hostOnly": true,
      "secure": true,
      "session": true,
      "storeId": "<string>",
      "sameSite": "<string>"
    }
  ],
  "persist_local_storage": true,
  "persist_cookies": true,
  "persist_session_storage": true,
  "allow_multiple_sessions": true,
  "max_concurrency": 123,
  "prevent_concurrency_during_login": true,
  "expiry_time_from_last_use": "<string>",
  "expiry_time_from_session_data_set": "<string>",
  "tfa_method": "AUTHENTICATOR"
}

Authorizations

cc-key

string

header

required

API key-based authentication. Provide your CloudCruise API key in the cc-key header.

Body

application/json

Comprehensive vault entry configuration for a user. Supports multiple authentication methods and persistence options to maintain user sessions across workflow executions. Credentials have to be encrypted with your own encryption key prior to sending to the API. Learn more about how to encrypt credentials here.

permissioned_user_id

string

required

Unique identifier for referencing this vault entry in workflow executions

user_name

string | null

required

Primary encrypted username or email

password

string | null

required

Encrypted password credential

domain

string

required

Target domain for vault entry credential

tfa_secret

string | null

Two-factor authenticator secret key (TOTP)

user_alias

string | null

A human readable identifier for the vault entry in the target system

persist_session_storage

boolean | null

Whether to maintain session storage across workflow executions

persist_local_storage

boolean | null

Whether to maintain local storage across workflow executions

persist_cookies

boolean | null

Whether to maintain cookies across workflow executions

allow_multiple_sessions

boolean | null

Controls whether the same set of credentials can be used simultaneously across multiple workflow executions. When set to true, multiple workflows can run in parallel using these credentials. When set to false or not specified, only one workflow can use these credentials at a time. We recommend keeping this as false (default) since some websites do not allow multiple active sessions for the same credentials and may invalidate existing sessions if a new one is detected.

max_concurrency

integer | null

Maximum number of concurrent sessions allowed when allow_multiple_sessions is true (null for unlimited)

Whether to prevent other sessions from starting while login is in progress

expiry_time_from_last_use

string | null

Session expiry interval from last activity using PostgreSQL interval format (e.g., "01:30:00" for 1.5 hours)

expiry_time_from_session_data_set

string | null

Session expiry interval from creation using PostgreSQL interval format (e.g., "7 days 00:00:00" for 7 days)

tfa_method

enum<string> | null

Two-factor authentication method:

AUTHENTICATOR: Time-based one-time password using provided secret
EMAIL: TFA codes sent to CloudCruise email (info+{user_id}+{domain}@cloudcruise.com)
SMS: TFA codes sent to CloudCruise phone (+1 415 753-4639)

Available options:

AUTHENTICATOR,

EMAIL,

SMS

proxy

object | null

Controls whether to use a proxy during browser agent runs with these credentials. If target_ip is provided, we will assign a proxy closest to that IP.

Show child attributes

Response

Vault entry successfully created

Complete vault entry including system-generated fields

permissioned_user_id

string<uuid>

System-generated unique identifier

user_name

string

Encrypted username

password

string

Encrypted password

domain

string

Target domain for vault entry credentials

user_alias

string

Human readable identifier

tfa_secret

string

Two-factor authentication secret

created_at

string<date-time>

Timestamp when the vault entry was created

session_storage

object

Session storage data

local_storage

object

Local storage data

object[]

Active vault entry cookies

Show child attributes

persist_local_storage

boolean

Whether to maintain local storage across sessions

persist_cookies

boolean

Whether to maintain cookies across sessions

persist_session_storage

boolean

Whether to maintain session storage across sessions

allow_multiple_sessions

boolean

Whether to allow multiple concurrent sessions

max_concurrency

integer | null

Maximum number of concurrent sessions allowed (null for unlimited)

Whether to prevent other sessions from starting while login is in progress

expiry_time_from_last_use

string | null

Session expiry interval from last activity (e.g., "01:30:00" for 1.5 hours). Set to null for no expiry from last use.

expiry_time_from_session_data_set

string | null

Session expiry interval from creation (e.g., "7 days 00:00:00" for 7 days). Set to null for no expiry from session data set.

tfa_method

enum<string> | null

Two-factor authentication method

Available options:

AUTHENTICATOR,

EMAIL,

SMS

Get workflow error analytics Get vault entries

⌘I

Getting Started

Concepts

API Reference

SDK

Notifications

Create vault entry

Authorizations

Body

Response