Rename a connector or change its client label (dashboard session only)
PATCH
/connectors/{id}
const url = 'https://api.krakenkey.io/connectors/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","clientLabel":{},"scopes":["certs:read"],"allowedCertIds":[1],"allowedDomainIds":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.krakenkey.io/connectors/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "clientLabel": {}, "scopes": [ "certs:read" ], "allowedCertIds": [ 1 ], "allowedDomainIds": [ "example" ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
clientLabel
Null clears it
object
scopes
Replaces the scopes. Must include certs:read. Changing it revokes live keys.
Array<string>
allowedCertIds
Replaces the certificate restriction; [] or null clears it. At least one restriction must remain. Changing it revokes live keys.
Array<number>
allowedDomainIds
Replaces the domain restriction; [] or null clears it. At least one restriction must remain. Changing it revokes live keys.
Array<string>