FishyKeys API (1.0)

Download OpenAPI specification:Download

The FishyKeys API for key management

key_management

The FishyKeys server handles master key operations

create_master_key key_management

Create a new master key and split it into shares

Request Body schema: application/json

admin_password required	string Admin password for key management
admin_username required	string Admin username for key management
min_shares required	integer <int64> Minimum number of shares required to reconstruct the key
total_shares required	integer <int64> Total number of shares to create

Responses

Request samples

Payload

Content type

application/json

{"admin_password": "admin_password123!",
"admin_username": "admin",
"min_shares": 3,
"total_shares": 5
}

Response samples

201

Content type

application/json

{"admin_username": "admin",
"shares": ["EXAMPLEA5ZKwDn8Zotr3B+d+F+UzrcJ1Yhl2rU0",
"EXAMPLEB5ZKwDn8Zotr3B+d+F+UzrcJ1Yhl2rU1",
"EXAMPLEC5ZKwDn8Zotr3B+d+F+UzrcJ1Yhl2rU2"
]
}

delete_share key_management

Delete a share from the key management system

Request Body schema: application/json

index

required

integer <int64>

The index of the share to delete

Responses

Request samples

Payload

Content type

application/json

{"index": 1
}

add_share key_management

Add a share to unlock the master key

Request Body schema: application/json

share

required

string

One of the shares need to unlock the master key

Responses

Request samples

Payload

Content type

application/json

{"share": "EXAMPLEA5ZKwDn8Zotr3B+d+F+UzrcJ1Yhl2rU0"
}

Response samples

201

Content type

application/json

{"index": 191041221977587000,
"unlocked": false
}

get_key_status key_management

Get the current status of the master key

Responses

Response samples

200

Content type

application/json

{"current_shares": 6938986088863093000,
"is_locked": true,
"min_shares": 7961477577792691000,
"total_shares": 4689996537036155000
}

secrets

User service manages user accounts and authentication

create secret secrets

Create a secret

Request Body schema: application/json

authorized_members required	Array of integers <int64> [ items <int64 > ] Members IDs authorized to access the secret
authorized_roles required	Array of integers <int64> [ items <int64 > ] Role IDs authorized to access the secret
path required	string >= 2 characters Base64 encoded secret's path
value required	string The secret value

Responses

Request samples

Payload

Content type

application/json

{"authorized_members": [5091348230372323000,
633220121447532700,
2121356811434194700
],
"authorized_roles": [2782797484439170000,
2748161521337896000,
5585384301853113000
],
"path": "L2N1c3RvbWVycy9nb29nbGUvYXBpX2tleQ==",
"value": "SECRET_API_KEY123"
}

get secret secrets

Retrieve a secret's information

path Parameters

path

required

string >= 2 characters

Example: L2N1c3RvbWVycy9nb29nbGUvYXBpX2tleQ==

Base64 encoded secret's path

Responses

Response samples

200

Content type

application/json

{"authorized_members": [{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
},
{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
},
{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
}
],
"authorized_roles": [{"id": 1,
"name": "admin"
},
{"id": 1,
"name": "admin"
},
{"id": 1,
"name": "admin"
}
],
"created_at": "2025-06-30T12:00:00Z",
"owner": {"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
},
"path": "customers/google/api_key",
"updated_at": "2025-06-30T15:00:00Z"
}

get secret value secrets

Retrieve a secret value

path Parameters

path

required

string >= 2 characters

Example: L2N1c3RvbWVycy9nb29nbGUvYXBpX2tleQ==

Base64 encoded secret's path

Responses

Response samples

200

Content type

application/json

{"path": "customers/google/api_key",
"value": "SECRET_API_KEY"
}

users

User service manages user accounts and authentication

list users users

List all users

Responses

Response samples

200

Content type

application/json

[{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
},
{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
},
{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
},
{"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T15:00:00Z",
"username": "alice"
}
]

create user users

Create a new user

Request Body schema: application/json

password required	string Password (hashed or plain depending on implementation)
username required	string >= 3 characters Username of the new user

Responses

Request samples

Payload

Content type

application/json

{"password": "s3cr3t",
"username": "alice"
}

Response samples

201

Content type

application/json

{"id": 2,
"username": "alice"
}

auth user users

Authenticate a user with username and password

Request Body schema: application/json

password required	string Password
username required	string Username

Responses

Request samples

Payload

Content type

application/json

{"password": "s3cr3t",
"username": "alice"
}

Response samples

200

Content type

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"username": "alice"
}

delete user users

Delete a user by username

path Parameters

username

required

string

Example: alice

Username of the user to delete