POST
/
api-key

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

input
object
required

Body

application/json
input
object
required

Response

200 - application/json

An API key allows to make calls through the API. It is linked to an organization.

id
any
required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

enabled
boolean
required

Whether the API key is enabled or not. If disabled, it will not be possible to make calls through the API with this key.

name
string
required

The name of the API key. It is used to identify the key in the UI.

secret
any
required

The secret of the API key. It is used to authenticate the key when making calls through the API.

organization
object
required

The organization that owns the API key.

createdAt
any
required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

updatedAt
any
required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.