Modbot Docs
APIAPI referenceAPI keys

Add API key

POST/api/api-keys

Make a key for yourself. The response carries the key. It is shown this once: only its hash is stored. The key can hold no permission you do not hold, and on every request it is narrowed again to what your account holds at that moment.

Needs the ManageApiKeys permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "permissions": [      "string"    ],    "expiresAt": null  }'
{  "apiKey": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "start": "string",    "permissionNames": [      "string"    ],    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",    "ownerName": null,    "createdAt": "2019-08-24T14:15:22Z",    "expiresAt": null,    "lastUsedAt": null,    "revokedAt": null,    "state": "string"  },  "key": "string"}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.