API referenceKeys and access
Add a vendor credential
Store your own key for a provider as the primary or fallback slot, envelope-encrypted. BYOK calls are never charged by GridRouter.
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" \ -H "Content-Type: application/json" \ -d '{ "fields": { "property1": "string", "property2": "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"}List vendor credentials GET
Your own vendor keys (BYOK) stored for this org: provider, slot, label, field names, the key's last four characters and its last test result. Secrets are write-only and never returned.
Remove a vendor credential DELETE
Delete one slot of your own key for a provider. Calls fall back to the next slot.