API Keys

Create a new API key for a user

post/api/auth/api-key/create

Request

  • Base URL: https://cloud.manufact.com
  • URL: https://cloud.manufact.com/api/auth/api-key/create
  • Auth: HTTP bearer

Request body

configIdstring

The configuration ID to use for the API key. If not provided, the default configuration will be used.

namestring

Name of the Api Key

expiresInnumber nullable

Expiration time of the Api Key in seconds

prefixstring

Prefix of the Api Key

metadataunknown
organizationIdstring

Organization Id of the organization that the Api Key belongs to. Eg: 'org-id'

Response

API key created successfully

idstring required

Unique identifier of the API key

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

namestring nullable

Name of the API key

prefixstring nullable

Prefix of the API key

startstring nullable

Starting characters of the key (if configured)

keystring required

The full API key (only returned on creation)

enabledboolean required

Whether the key is enabled

expiresAtstring date-time nullable

Expiration timestamp

referenceIdstring required

ID of the reference owning the key

lastRefillAtstring date-time nullable

Last refill timestamp

lastRequeststring date-time nullable

Last request timestamp

metadataobject nullable

Metadata associated with the key

rateLimitMaxnumber nullable

Maximum requests in time window

rateLimitTimeWindownumber nullable

Rate limit time window in milliseconds

remainingnumber nullable

Remaining requests

refillAmountnumber nullable

Amount to refill

refillIntervalnumber nullable

Refill interval in milliseconds

rateLimitEnabledboolean required

Whether rate limiting is enabled

requestCountnumber required

Current request count in window

permissionsobject nullable

Permissions associated with the key

Changes

No recorded changes to this operation across all 1 revision of this API.