Endpoint

/v1/file-system/security/keys/{key_ref}/replace

POST

Replace the file system public key by using the name or identifier of the specified key.

Parameters

Name Description Required
key_ref The name or identifier of the key to replace. Yes
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_change_lock_key_replace_request",
  "type": "object",
  "properties": {
    "replacement_key": {
      "description": "The replacement public key.",
      "type": "string"
    },
    "old_key_verification_signature": {
      "description": "The key replacement challenge signed with the current private key.",
      "type": "string"
    },
    "replacement_key_verification_signature": {
      "description": "The key replacement challenge signed with the replacement private key.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_change_lock_key",
  "type": "object",
  "properties": {
    "id": {
      "description": "The identifier associated with the specified key.",
      "type": "string"
    },
    "name": {
      "description": "The unique name of the specified key.",
      "type": "string"
    },
    "comment": {
      "description": "A descriptive comment about the specified key.",
      "type": "string"
    },
    "disabled": {
      "description": "Specifies whether the key is disabled.",
      "type": "boolean"
    },
    "public_key": {
      "description": "The contents of the public key.",
      "type": "string"
    }
  }
}