Keywords

Read Keyword

get

Path parameters

uidintegerRequired

Responses

200

Successful Response

application/json

idintegerRequired

keywordstringRequired

replacementstringRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/obfuscation/keywords/{uid}

GET /api/v2/obfuscation/keywords/{uid} HTTP/1.1
Accept: */*

{
  "id": 1,
  "keyword": "text",
  "replacement": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update Keyword

put

Path parameters

uidintegerRequired

Body

keywordstring · min: 3Required

replacementstring · min: 3Required

Responses

200

Successful Response

application/json

idintegerRequired

keywordstringRequired

replacementstringRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/obfuscation/keywords/{uid}

PUT /api/v2/obfuscation/keywords/{uid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "keyword": "text",
  "replacement": "text"
}

{
  "id": 1,
  "keyword": "text",
  "replacement": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete Keyword

delete

Path parameters

uidintegerRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete/api/v2/obfuscation/keywords/{uid}

DELETE /api/v2/obfuscation/keywords/{uid} HTTP/1.1
Accept: */*

No content

Read Keywords

get

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

get/api/v2/obfuscation/keywords

GET /api/v2/obfuscation/keywords HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "keyword": "text",
      "replacement": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create Keyword

post

Body

keywordstring · min: 3Required

replacementstring · min: 3Required

Responses

201

Successful Response

application/json

idintegerRequired

keywordstringRequired

replacementstringRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/obfuscation/keywords

POST /api/v2/obfuscation/keywords HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "keyword": "text",
  "replacement": "text"
}

{
  "id": 1,
  "keyword": "text",
  "replacement": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Read Obfuscation Configs

get

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

get/api/v2/obfuscation/global

GET /api/v2/obfuscation/global HTTP/1.1
Accept: */*

{
  "records": [
    {
      "language": "text",
      "enabled": true,
      "command": "text",
      "module": "text",
      "preobfuscatable": true
    }
  ]
}

Read Obfuscation Config

get

Path parameters

languagestringRequired

Responses

200

Successful Response

application/json

languagestringRequired

enabledbooleanRequired

commandstringRequired

modulestringRequired

preobfuscatablebooleanRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/obfuscation/global/{language}

GET /api/v2/obfuscation/global/{language} HTTP/1.1
Accept: */*

{
  "language": "text",
  "enabled": true,
  "command": "text",
  "module": "text",
  "preobfuscatable": true
}

Update Obfuscation Config

put

Path parameters

languagestringRequired

Body

enabledbooleanRequired

commandstringRequired

modulestringRequired

Responses

200

Successful Response

application/json

languagestringRequired

enabledbooleanRequired

commandstringRequired

modulestringRequired

preobfuscatablebooleanRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/obfuscation/global/{language}

PUT /api/v2/obfuscation/global/{language} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "enabled": true,
  "command": "text",
  "module": "text"
}

{
  "language": "text",
  "enabled": true,
  "command": "text",
  "module": "text",
  "preobfuscatable": true
}

Preobfuscate Modules

post

Path parameters

languagestringRequired

Query parameters

reobfuscatebooleanOptionalDefault: false

Responses

202

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/obfuscation/global/{language}/preobfuscate

POST /api/v2/obfuscation/global/{language}/preobfuscate HTTP/1.1
Accept: */*

No content

Remove Preobfuscated Modules

delete

Path parameters

languagestringRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete/api/v2/obfuscation/global/{language}/preobfuscate

DELETE /api/v2/obfuscation/global/{language}/preobfuscate HTTP/1.1
Accept: */*

No content