Error
A valid request URL is required to generate request examples{
"item_listing": true,
"password_write": false,
"item_search": false
}{
"error": {
"code": "invalid_request",
"message": "ref is required"
}
}{
"error": {
"code": "invalid_signature",
"message": "Signature verification failed"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}Custom Secret Provider API
Report supported optional endpoints
Called when the connection is created and when a user clicks Test
connection. CloudCruise stores the result on the connection, so
after enabling an optional endpoint, click Test connection again.
A 200 proves that your endpoint is reachable and that signature
verification works.
POST
/
v1
/
capabilities
Error
A valid request URL is required to generate request examples{
"item_listing": true,
"password_write": false,
"item_search": false
}{
"error": {
"code": "invalid_request",
"message": "ref is required"
}
}{
"error": {
"code": "invalid_signature",
"message": "Signature verification failed"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}{
"error": {
"code": "item_not_found",
"message": "<string>"
}
}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: trueif you implementPOST /v1/items/list.password_writeanditem_searchare reserved: returnfalsefor both in this version.
Authorizations
v1=<hex HMAC-SHA256>, possibly several comma-separated values during
a secret rotation. See Request authentication above.
Unix time in seconds, part of the signed string. Reject if more than 300 seconds off.
Headers
Unique per request; never reused, including across retries.
The CloudCruise connection id. Not secret.
Body
application/json
Currently empty. Send {}; ignore unknown properties.
Response
Capabilities of this endpoint.
Was this page helpful?

