API referenceKeys and access
Rename a vendor credential
Set or clear the label of a stored key. The secret is not touched.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
provider*string
Match
^[a-z0-9]+(-[a-z0-9]+)*$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v1/credentials/string/label" \ -H "Content-Type: application/json" \ -d '{ "label": "string" }'{ "object": "credential", "id": "string", "provider": "string", "slot": "primary", "fields": [ "string" ], "label": null, "hint": null, "status": "healthy", "tested_at": null, "test_message": null, "last_used_at": null, "updated_at": "2019-08-24T14:15:22Z"}Test a vendor credential POST
Call the provider's free, read-only test endpoint (for example a credit balance) with your stored key. Never charged; the call is logged.
Test a vendor key before saving it POST
Call the provider's free, read-only test endpoint with a key that is not stored yet. Nothing is saved; the key is used for this one call. Never charged; the call is logged.