Help Search

Edit on github

Find a OpenPGP Key by id

You can also query one single GPG key by making a GET request to /gpgkeys/.json.

GET /gpgkeys/<gpgKeyId>.json

Possible responses

Code Description
200 OK
The request was successful. Response includes the single GPG Key object.
400 Bad Request
When gpgKeyId is not valid UUID
404 Not Found
A GPG Key for the given gpgKeyId is not found.

Examples

Success example

{
    "header": {
        "id": "cc867d1d-a285-4caf-91dc-ea5b7423c198",
        "status": "success",
        "servertime": 1556048915,
        "action": "f07aa7d7-410d-5c49-bd11-407788f0e1b4",
        "message": "The operation was successful.",
        "url": "\/gpgkeys\/0239c721-8b7d-59fc-9bff-69e75aff349c.json",
        "code": 200
    },
    "body": {
        "id": "0239c721-8b7d-59fc-9bff-69e75aff349c",
        "user_id": "af5e1f70-a0ee-5b76-935b-c846f8a6a190",
        "armored_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----",
        "bits": 2048,
        "uid": "Passbolt dummy \u[email protected]\u003E",
        "key_id": "9B09131B",
        "fingerprint": "3657D402E639639657E314D1EC7BBEFF9B09131B",
        "type": "RSA",
        "expires": "2022-11-29T05:26:48+00:00",
        "key_created": "2018-11-29T05:26:48+00:00",
        "deleted": false,
        "created": "2019-04-17T14:45:26+00:00",
        "modified": "2019-04-17T14:45:26+00:00"
    }
}

Last updated

This article was last updated on April 23rd, 2019.

For another perspective on the API you browse the OpenAPI 2.0 specifications using the dedicated API reference site (Swagger UI).

API Reference

You can also find the latest OpenAPI 2.0 specifications directly on the dedicated repository.

OpenAPI Specs repository