/api/v1/simulator/credential (PUT)

PUT

/api/v1/simulator/credential

curl --request PUT \
  --url https://example.com/api/v1/simulator/credential \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "apiKey": "example" }'

Authorizations

• Bearer

Request Body^required

object

apiKey

required

string

Example ^generated

{
  "apiKey": "example"
}

object

apiKey

required

string

Example ^generated

{
  "apiKey": "example"
}

object

apiKey

required

string

Example ^generated

{
  "apiKey": "example"
}

Responses

200

OK

object

configured

required

boolean

keyPrefix

required

string

nullable

updatedAt

required

string format: date-time

nullable

lastCheck

required

object

ok

required

boolean

checkedAt

required

string format: date-time

problems

required

Array<object>

object

code

required

string

detail

required

string

feature

required

string

nullable

permission

required

string

nullable

object

configured

required

boolean

keyPrefix

required

string

nullable

updatedAt

required

string format: date-time

nullable

lastCheck

required

object

ok

required

boolean

checkedAt

required

string format: date-time

problems

required

Array<object>

object

code

required

string

detail

required

string

feature

required

string

nullable

permission

required

string

nullable

Example ^generated

{
  "configured": true,
  "keyPrefix": "example",
  "updatedAt": "2026-04-15T12:00:00Z",
  "lastCheck": {
    "ok": true,
    "checkedAt": "2026-04-15T12:00:00Z",
    "problems": [
      {
        "code": "example",
        "detail": "example",
        "feature": "example",
        "permission": "example"
      }
    ]
  }
}

object

configured

required

boolean

keyPrefix

required

string

nullable

updatedAt

required

string format: date-time

nullable

lastCheck

required

object

ok

required

boolean

checkedAt

required

string format: date-time

problems

required

Array<object>

object

code

required

string

detail

required

string

feature

required

string

nullable

permission

required

string

nullable

Example ^generated

{
  "configured": true,
  "keyPrefix": "example",
  "updatedAt": "2026-04-15T12:00:00Z",
  "lastCheck": {
    "ok": true,
    "checkedAt": "2026-04-15T12:00:00Z",
    "problems": [
      {
        "code": "example",
        "detail": "example",
        "feature": "example",
        "permission": "example"
      }
    ]
  }
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

503

Service Unavailable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}