WebsiteTruvera Workspace

Keys

List all keys

get
/keys
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
Responses
200

A paged array of keys

application/json
get
/keys
GET /keys HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "ips": [
      "text"
    ],
    "alias": "My API",
    "key": "text",
    "created": "text",
    "expires": "text"
  }
]

Create a key

post
/keys
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ipsstring[]Optional
aliasstring | nullableOptional

A human-readable name for the key

Example: My Key
Responses
200

Key has been created

application/json
Responseall of
post
/keys
POST /keys HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "ips": [
    "text"
  ],
  "alias": "My Key"
}
{
  "ips": [
    "text"
  ],
  "alias": "My API",
  "key": "text",
  "created": "text",
  "expires": "text",
  "jwt": "text"
}

Delete a key

delete
/keys/{publicKey}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
publicKeystringRequired

A public key

Responses
200

Key has been deleted

application/json
delete
/keys/{publicKey}
DELETE /keys/{publicKey} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "revoked": true
}

Update a key

patch
/keys/{publicKey}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
publicKeystringRequired

A public key

Body
ipsstring[]Optional
aliasstring | nullableOptional

A human-readable name for the key

Example: My Key
Responses
200

Key has been updated

application/json
patch
/keys/{publicKey}
PATCH /keys/{publicKey} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "ips": [
    "text"
  ],
  "alias": "My Key"
}
{
  "ips": [
    "text"
  ],
  "alias": "My API",
  "key": "text",
  "created": "text",
  "expires": "text"
}

Certs internal route, not for typical usage. Generates a temporary key

post
/keys/temporary-key
Authorizations
CERTS-TOKENstringRequired
Body
subaccountintegerOptional
selectedTeamIdintegerOptional
isTestmodebooleanOptional
Responses
200

Temporary key has been created

application/json
post
/keys/temporary-key
POST /keys/temporary-key HTTP/1.1
Host: api-testnet.truvera.io
CERTS-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "subaccount": 1,
  "selectedTeamId": 1,
  "isTestmode": true
}
{
  "key": "text",
  "selectedTeamId": 1
}
PreviousVerifyNextSchemas

Last updated

Was this helpful?