Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
MetaGer Keymanager
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
open-source
MetaGer Keymanager
Commits
814fa60c
Commit
814fa60c
authored
1 year ago
by
Phil Höfer
Browse files
Options
Downloads
Patches
Plain Diff
Fix typos and outdated info.
parent
2af80380
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#8026
passed
1 year ago
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/api.md
+9
-9
9 additions, 9 deletions
docs/api.md
with
9 additions
and
9 deletions
docs/api.md
+
9
−
9
View file @
814fa60c
...
@@ -4,7 +4,7 @@ Keymanager supports a JSON API to manage and query keys.
...
@@ -4,7 +4,7 @@ Keymanager supports a JSON API to manage and query keys.
## Authentication
## Authentication
API access is granted only
authenticated
y
ou need to supply an Authorization header with
every
request.
Most API methods are only available
authenticated
. Y
ou need to supply an Authorization header with
those
request
s
.
```
```
Authorization: Bearer <API-Key>
Authorization: Bearer <API-Key>
...
@@ -12,8 +12,8 @@ Authorization: Bearer <API-Key>
...
@@ -12,8 +12,8 @@ Authorization: Bearer <API-Key>
## `POST /api/json/key/create`
## `POST /api/json/key/create`
Creates a key and charges it by specified amount. Creates a
O
rder to do so. A note can be attached to the
O
rder.
Creates a key and charges it by
the
specified amount. Creates a
o
rder to do so. A note can be attached to the
o
rder.
`manual`
is currently the only valid payment processor for API.
`manual`
is currently the only valid payment processor for API
use
.
Can take either amount or price. If both supplied only amount is taken into account.
Can take either amount or price. If both supplied only amount is taken into account.
### Parameters
### Parameters
...
@@ -28,7 +28,7 @@ Can take either amount or price. If both supplied only amount is taken into acco
...
@@ -28,7 +28,7 @@ Can take either amount or price. If both supplied only amount is taken into acco
### Example Response
### Example Response
Successfull discharge will have a response code of
`201`
Successfull discharge will have a response code of
`201`
If the key cannot be charged because it is already charged with too many
O
rders response code will be
`403`
If the key cannot be charged because it is already charged with too many
o
rders
and the
response code will be
`403`
```
json
```
json
{
{
...
@@ -88,8 +88,8 @@ Successfull discharge will have a response code of `201`
...
@@ -88,8 +88,8 @@ Successfull discharge will have a response code of `201`
## `POST /api/json/key/:key/charge`
## `POST /api/json/key/:key/charge`
Charges a key by specified amount. Creates a Order to do so. A note can be attached to the
O
rder.
Charges a key by specified amount. Creates a Order to do so. A note can be attached to the
o
rder.
`manual`
is currently the only valid payment processor for API.
`manual`
is currently the only valid payment processor for API
use
.
Can take either amount or price. If both supplied only amount is taken into account.
Can take either amount or price. If both supplied only amount is taken into account.
### Parameters
### Parameters
...
@@ -117,7 +117,7 @@ If the key cannot be charged because it is already charged with too many Orders
...
@@ -117,7 +117,7 @@ If the key cannot be charged because it is already charged with too many Orders
## `GET /api/json/token/pubkey`
## `GET /api/json/token/pubkey`
Retrieves the pubkey the server is using currently for token signatures.
Retrieves the pubkey the server is using currently for token signatures.
This
M
ethod does not require authentication
This
m
ethod does not require authentication
### Example Response
### Example Response
...
@@ -135,7 +135,7 @@ This Method does not require authentication
...
@@ -135,7 +135,7 @@ This Method does not require authentication
Signs submitted blinded tokens with the servers private key. The submitted key needs to hold a charge for each token or the request will fail.
Signs submitted blinded tokens with the servers private key. The submitted key needs to hold a charge for each token or the request will fail.
The Key will be discharged by this action.
The Key will be discharged by this action.
You cannot submit more than 10 tokens to be signed.
You cannot submit more than 10 tokens to be signed.
This
M
ethod does not require authentication
This
m
ethod does not require authentication
### Parameters
### Parameters
...
@@ -201,7 +201,7 @@ If any validation errors (signature, token format, etc.) occured response code w
...
@@ -201,7 +201,7 @@ If any validation errors (signature, token format, etc.) occured response code w
## `POST /api/json/token/use`
## `POST /api/json/token/use`
Uses supplied
T
okens to be consumed for MetaGer search. All supplied
T
okens will be invalid after this action.
Uses supplied
t
okens to be consumed for MetaGer search. All supplied
t
okens will be invalid after this action.
You cannot submit more than 10 tokens to be used.
You cannot submit more than 10 tokens to be used.
### Parameters
### Parameters
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment