PUT /settings/security/api-keys/\{id\}

PUT 
/settings/security/api-keys/:id

PUT /settings/security/api-keys/{id}

Request

Path Parameters

id int64required

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

200

OK

text/plain

Schema

Schema

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

]

Example (from schema)

{
  "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
    }
  ]
}

application/json

Schema

Schema

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

]

Example (from schema)

{
  "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
    }
  ]
}

text/json

Schema

Schema

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

]

Example (from schema)

{
  "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
    }
  ]
}

Loading...