Skip to main content
PUT
/
keys
/
{keyId}
Update Key
curl --request PUT \
  --url https://api.dfns.io/keys/{keyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '{
  "name": "<string>"
}'
{
  "id": "<string>",
  "scheme": "DH",
  "curve": "ed25519",
  "publicKey": "<string>",
  "masterKey": true,
  "derivedFrom": {
    "keyId": "key-01snl-t56gb-j8tsok0vn802p80i",
    "path": "<string>"
  },
  "name": "<string>",
  "status": "Active",
  "custodial": true,
  "dateCreated": "<string>",
  "imported": true,
  "exported": true,
  "dateExported": "<string>",
  "dateDeleted": "<string>"
}

​
Authentication

✅ Organization User (CustomerEmployee)
✅ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Keys:Update: Always required.

Authorizations

​
Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

​
X-DFNS-USERACTION
string
header
required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Path Parameters

​
keyId
string
required
Minimum length: 1

Body

application/json
​
name
string | null
required
Maximum length: 100

Response

200 - application/json

Success

​
id
string
required
​
scheme
enum<string>
required
Available options:
DH,
ECDSA,
EdDSA,
Schnorr
​
curve
enum<string>
required
Available options:
ed25519,
secp256k1,
stark
​
publicKey
string
required
​
status
enum<string>
required
Available options:
Active,
Archived
​
custodial
boolean
required
​
dateCreated
string
required
​
masterKey
boolean
​
derivedFrom
object
​
name
string
​
imported
boolean
​
exported
boolean
​
dateExported
string
​
dateDeleted
string