Keys

List all keys

get

https://api-testnet.truvera.iohttps://api.truvera.io

/keys

Authorizations

bearerAuthaccessTokennextAuth

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

400

Application error

application/json

get

/keys

HTTPcURLJavaScriptPython

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

https://api-testnet.truvera.iohttps://api.truvera.io

/keys

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ipsstring[]Optional

aliasstring | nullableOptional

A human-readable name for the key

Example: My Key

Responses

200

Key has been created

application/json

400

Something went wrong.

application/json

403

Forbidden

application/json

post

/keys

HTTPcURLJavaScriptPython

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

https://api-testnet.truvera.iohttps://api.truvera.io

/keys/{publicKey}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

publicKeystringRequired

A public key

Responses

200

Key has been deleted

application/json

400

Something went wrong.

application/json

404

Key was not found.

application/json

delete

/keys/{publicKey}

HTTPcURLJavaScriptPython

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

{
  "revoked": true
}

Update a key

patch

https://api-testnet.truvera.iohttps://api.truvera.io

/keys/{publicKey}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

publicKeystringRequired

A public key

Body

application/json

ipsstring[]Optional

aliasstring | nullableOptional

A human-readable name for the key

Example: My Key

Responses

200

Key has been updated

application/json

400

Something went wrong.

application/json

404

Key was not found.

application/json

patch

/keys/{publicKey}

HTTPcURLJavaScriptPython

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

https://api-testnet.truvera.iohttps://api.truvera.io

/keys/temporary-key

Authorizations

nextAuth

CERTS-TOKENstringRequired

Body

application/json

subaccountintegerOptional

selectedTeamIdintegerOptional

isTestmodebooleanOptional

Responses

200

Temporary key has been created

application/json

400

Application error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/keys/temporary-key

HTTPcURLJavaScriptPython

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
}