Skip to content

List public keys

GET
/v1/public_keys
curl --request GET \
--url http://api.disclosebot.localdev:3000/v1/public_keys \
--header 'Authorization: Bearer <token>'

The organisation’s public keys, newest first, filterable with ransack predicates on name, short_description, retired_at, and created_at, paginated.

page[number]
integer
page[size]
integer
q[name_cont]
string

Name contains

q[retired_at_null]
boolean

True for keys in use, false for retired keys

q[s]
string

Sort, e.g. “name asc”

Filtered to keys in use, by name

Media type application/json
object
data
required
Array<object>
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
meta
required
object
pagination
required
object
current
required
integer
first
integer
prev
integer
next
integer
last
integer
records
required

The unpaginated total

integer
links
required
object
key
additional properties
string
Example
{
"data": [
{
"type": "public_key"
}
]
}

Unauthorized