v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB

AuthKeys

Search auth keys

post/auth_keys

Request body

pageinteger nullable

limitinteger nullable

Maximum number of results to be returned. Can't be greater than the one set for your role. 0 means maximum.

idstring

uuidstring uuid

authkey_startstring

Search term matching the first 4 characters of the authkey

authkey_endstring

Search term matching the last 4 characters of the authkey

createdstring nullable

You can use any of the valid time related filters (examples: 7d, timestamps, [14d, 7d] for ranges, etc.)

expirationstring nullable

You can use any of the valid time related filters (examples: 7d, timestamps, [14d, 7d] for ranges, etc.)

read_onlyboolean

user_idstring

commentstring

allowed_ipsstring

Stringified JSON array of the IP addresses.

last_usedstring nullable

You can use any of the valid time related filters (examples: 7d, timestamps, [14d, 7d] for ranges, etc.)

Example request

{
  "id": "12345",
  "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
  "user_id": "12345",
  "allowed_ips": "[\"127.0.0.1\",\"127.0.0.2\"]"
}

Response

Get auth keys response

Example response

[
  {
    "AuthKey": {
      "id": "12345",
      "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
      "created": "1617875568",
      "expiration": "1970-01-01 00:00:00",
      "user_id": "12345",
      "allowed_ips": [
        "127.0.0.1"
      ],
      "last_used": "1617875568"
    },
    "User": {
      "id": "12345"
    }
  }
]