Skip to main content
POST
Error
Note:
  • Your endpoint, not CloudCruise, hosts this operation. Every request is signed; see request authentication.
  • Return metadata only, never secret values. This operation is not cached, so keep it cheap.

Authorizations

X-CloudCruise-Signature
string
header
required

v1=<hex HMAC-SHA256>, possibly several comma-separated values during a secret rotation. See Request authentication above.

X-CloudCruise-Timestamp
string
header
required

Unix time in seconds, part of the signed string. Reject if more than 300 seconds off.

Headers

X-CloudCruise-Request-Id
string<uuid>
required

Unique per request; never reused, including across retries.

X-CloudCruise-Connection-Id
string<uuid>
required

The CloudCruise connection id. Not secret.

Body

application/json
ref
string
required

Your identifier for one item. Opaque to CloudCruise.

Required string length: 1 - 512
Pattern: ^[\x20-\x7E]+$
Example:

"prod/acme-portal/login"

Response

The item's metadata.

ref
string
required

Your identifier for one item. Opaque to CloudCruise.

Required string length: 1 - 512
Pattern: ^[\x20-\x7E]+$
Example:

"prod/acme-portal/login"

title
string
required

Display name of the item.

Required string length: 1 - 200
group_id
string | null

Optional folder, vault or collection the item belongs to.

Maximum string length: 512
group_name
string | null

Display name of the group, shown next to the item in the picker.

Maximum string length: 200