Skip to content

Create a public key

POST
/v1/public_keys
curl --request POST \
--url http://api.disclosebot.localdev:3000/v1/public_keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "data": { "type": "public_key", "attributes": { "name": "example", "short_description": "example", "public_key": "example" } } }'

Adds a public key. An X25519 key, base64 of the 32 raw bytes, can be used by transmit steps and Cloak Mode; other kinds (a PGP key) are stored for reference.

Media type application/json
object
data
required
object
type
required
string
Allowed values: public_key
attributes
required
object
name
required
string
short_description
string
public_key
required
string

A PGP key, stored for reference

Media type application/json
object
data
required
object
id
required
string format: uuid
type
required
string
Allowed values: public_key
attributes
required
object
name
required
string
short_description
string
nullable
public_key
required

The key material. An X25519 key (base64 of the 32 raw bytes) can be used for encryption and cloaking; a PGP key is stored for reference.

string
retired
required

A retired key is not offered for new encryption or cloaking; what was encrypted to it keeps its link

boolean
retired_at
string format: date-time
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
relationships
object
Example
{
"data": {
"type": "public_key"
}
}

Unauthorized

Blank name or key