Skip to main content
POST
Error
Note:
  • Your endpoint, not CloudCruise, hosts this operation. Every request is signed; see request authentication.
  • Sent when a user clicks Connect, and again on Test connection. A failing call means the connection is not created.
  • Return item_listing: true if you implement POST /v1/items/list. password_write and item_search are reserved: return false for both in this version.

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

Currently empty. Send {}; ignore unknown properties.

Response

Capabilities of this endpoint.

item_listing
boolean
required

true if POST /v1/items/list is implemented. Without it, users type the ref when binding a credential.

password_write
boolean
required

Reserved: return false in this version.

Reserved: return false in this version.