Skip to content

POST Generate API key with credentials

POST /generate-api-key: Generate API key with credentials. Authenticate with username/password and generate a new API key with specified scopes and expiration

POSThttps://api.rooom.com/generate-api-key
Try it out

Body required

multipart/form-data
NameTypeDescription
usernamerequired
Example: user@example.com
stringUsername or email address
passwordrequired
Example: SecurePass123!
stringUser password
namerequired
Example: Mobile App Integration
stringDescriptive name for the API key
expiry
Example: 2030-12-31
stringAPI key expiration date (YYYY-MM-DD), must be in the future
scopesrequired
Example: [ "user:read", "space:read", "viewer:read" ]
arrayList of permission scopes for the API key, at least one valid scope is required

Responses

200Successfully generated API key
400Invalid request - at least one valid scope and a future expiry date are required
401Unauthorized
500Server error
POST /generate-api-key Generate API key with credentials Authenticate with username/password and generate a new API key with specified scopes and expiration for programmatic access. username Username or email address password User password name Descriptive name for the API key expiry API key expiration date (YYYY-MM-DD), must be in the future scopes List of permission scopes for the API key, at least one valid scope is required