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

Endpoint

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

GET

Get 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.	Yes

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"
    }
  }
}

PUT

Put 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.	Yes
`If-Match`	ETag for expected version	No

Request

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"
    }
  }
}

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"
    }
  }
}

DELETE

Delete 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.	Yes

Response

Codes

Code	Description
200	Return value on success

PATCH

Patch 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.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_change_lock_key_patch",
  "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"
    }
  }
}

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"
    }
  }
}