POST /settings/security/api-keys

POST 
/settings/security/api-keys

POST /settings/security/api-keys

Request

application/json-patch+json

Body

name stringrequired

Possible values: <= 200 characters

enabled boolean
expires_at datenullable

permissions

object[]

required

Possible values: <= 1000

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

application/json

Body

name stringrequired

Possible values: <= 200 characters

enabled boolean
expires_at datenullable

permissions

object[]

required

Possible values: <= 1000

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

text/json

Body

name stringrequired

Possible values: <= 200 characters

enabled boolean
expires_at datenullable

permissions

object[]

required

Possible values: <= 1000

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

application/*+json

Body

name stringrequired

Possible values: <= 200 characters

enabled boolean
expires_at datenullable

permissions

object[]

required

Possible values: <= 1000

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

Responses

201

Created

text/plain

Schema

Schema

key

object

id int64

name stringnullable

enabled boolean

created_at date-time

expires_at datenullable

revoked_at date-timenullable

permissions

object[]

nullable

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

credential stringnullable

Example (from schema)

{
  "key": {
    "id": 0,
    "name": "string",
    "enabled": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "expires_at": "2024-07-29",
    "revoked_at": "2024-07-29T15:51:28.071Z",
    "permissions": [
      {
        "module": "string",
        "feature": "string",
        "access": true
      }
    ]
  },
  "credential": "string"
}

application/json

Schema

Schema

key

object

id int64

name stringnullable

enabled boolean

created_at date-time

expires_at datenullable

revoked_at date-timenullable

permissions

object[]

nullable

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

credential stringnullable

Example (from schema)

{
  "key": {
    "id": 0,
    "name": "string",
    "enabled": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "expires_at": "2024-07-29",
    "revoked_at": "2024-07-29T15:51:28.071Z",
    "permissions": [
      {
        "module": "string",
        "feature": "string",
        "access": true
      }
    ]
  },
  "credential": "string"
}

text/json

Schema

Schema

key

object

id int64

name stringnullable

enabled boolean

created_at date-time

expires_at datenullable

revoked_at date-timenullable

permissions

object[]

nullable

Array [

module stringnullable

feature stringrequired

Possible values: <= 200 characters

access boolean

]

credential stringnullable

Example (from schema)

{
  "key": {
    "id": 0,
    "name": "string",
    "enabled": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "expires_at": "2024-07-29",
    "revoked_at": "2024-07-29T15:51:28.071Z",
    "permissions": [
      {
        "module": "string",
        "feature": "string",
        "access": true
      }
    ]
  },
  "credential": "string"
}

Loading...