List Fault Configs

get/api/accounts/{accountId}/fault-configs

Lists all fault configs for the identified account.

Request

Path Parameters

accountIdstringrequired
ID of the account to list the fault configs for.

Response

Successful operation.

Body application/json

itemsobject[]
Items
- accountIdstring
  The ID of the account the fault config is for.
- faultTypeNamestring
  The name of the fault type the configuration is for.
- valuestring
  The value set for the fault config. This is returned as a string, but can represent a string, number, or boolean, depending on the fault type.
- createdAtstring
  The timestamp when the fault config was created.

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{accountId}/fault-configs' \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "items": [
    {
      "accountId": "e4b66d1ddecbf518f5f337n5e5a4f682",
      "faultTypeName": "payment-handle-http-error",
      "value": "true",
      "createdAt": "2023-10-01T12:34:56Z"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}