Endpoint

/v1/file-system/security/keys/

GET

List the file system’s public keys.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_change_lock_keys",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "A list of the key\u2019s properties.",
        "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"
          }
        }
      }
    }
  }
}

POST

Register a new file system public key.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_change_lock_key_create_request",
  "type": "object",
  "properties": {
    "name": {
      "description": "The unique name of the specified key.",
      "type": "string"
    },
    "comment": {
      "description": "A descriptive comment about the specified key.",
      "type": "string"
    },
    "public_key": {
      "description": "The public key.",
      "type": "string"
    },
    "verification_signature": {
      "description": "The name of the key signed with the 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"
    }
  }
}