API Keys

Create API Key

Generates a new API key. **The full key is only returned once upon creation.** Ensure you save it securely.

POST
/api/v1/api-keys

Authorization

veriworkly-auth.session_token<token>

Internal session cookie for local development.

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.veriworkly.com/api/v1/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "My Documentation Key"  }'
{
  "success": true,
  "message": "string",
  "data": {
    "id": "string",
    "key": "vw_a1b2c3...x9y0z1",
    "name": "string",
    "isActive": true,
    "rateLimit": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastUsed": "2019-08-24T14:15:22Z"
  }
}
{
  "success": true,
  "message": "string",
  "statusCode": 0,
  "details": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "success": false,
  "statusCode": 401,
  "message": "Authentication required"
}