Entity Key
==========

.. code-block:: http

    /api/repositories/{repository}/entities/{entity}/keys/:keyID

.. csv-table::
    :header: Parameter, Type, Purpose
    :widths: 20, 20, 60
    :stub-columns: 1

    repository, string, the name of the :doc:`repository`
    entity, int, The ID of the entity to view
    keyID, string, The ID for the key

Commands
~~~~~~~~

.. _lek_edit:

Edit
----

.. http:post:: /api/repositories/(string:repository)/entities/(int:entityID)/keys/(int:keyID)
    :synopsis: Edit status of a discovered or permanent key

    Edit status of the corresponding discovered or permanent key.

.. code-block:: http

    POST /api/repositories/alpha/entities/1/keys/1 HTTP/1.1
    Content-Type: application/json

    {
        "command": "edit",
        "data": {
            "status": "Discovered"
        }
    }

.. csv-table::
    :header: Response Code, Reason
    :widths: 25, 75

    204, No error
    400, Invalid data passed with request
    500, Server error

The request requires a :doc:`standard-request` packet. Available commands are:

.. csv-table::
    :header: Command, Description
    :widths: 30, 70

    edit, Edit the status of the key to Discovered or Permanent

The request packet must contain the :code:`command` and :code:`data` elements.

Following fields should be send as part of data:
    status, string, It should be either `Permanent` or `Discovered`.

.. _lek_delete:

Delete
~~~~~~

.. http:delete:: /api/repositories/(string:repository)/entities/(int:entityID)/keys/(int:keyID)
    :synopsis: Delete a discovered or permanent key

    Delete the corresponding discovered or permanent key.

.. code-block:: http

    DELETE /api/repositories/jupiter/entities/1/keys/_1 HTTP/1.1

.. csv-table::
    :header: Response Code, Reason
    :widths: 25, 75

    204, Success
    400, Invalid data passed with request
    500, Server error