Bypasses

Read Bypass

get

Path parameters

uidintegerRequired

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

languagestringRequired

codestringRequired

is_defaultbooleanRequired

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/bypasses/{uid}

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

{
  "id": 1,
  "name": "text",
  "authors": [
    {
      "name": "text",
      "handle": "text",
      "link": "text"
    }
  ],
  "language": "text",
  "code": "text",
  "is_default": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update Bypass

put

Path parameters

uidintegerRequired

Body

namestringRequired

languagestringRequired

codestringRequired

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

languagestringRequired

codestringRequired

is_defaultbooleanRequired

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/bypasses/{uid}

PUT /api/v2/bypasses/{uid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": "text",
  "language": "text",
  "code": "text"
}

{
  "id": 1,
  "name": "text",
  "authors": [
    {
      "name": "text",
      "handle": "text",
      "link": "text"
    }
  ],
  "language": "text",
  "code": "text",
  "is_default": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete Bypass

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/bypasses/{uid}

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

No content

Read Bypasses

get

Query parameters

defaultboolean · nullableOptional

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/bypasses

GET /api/v2/bypasses HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "name": "text",
      "authors": [
        {
          "name": "text",
          "handle": "text",
          "link": "text"
        }
      ],
      "language": "text",
      "code": "text",
      "is_default": true,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create Bypass

post

Body

namestringRequired

languagestringRequired

codestringRequired

Responses

201

Successful Response

application/json

idintegerRequired

namestringRequired

languagestringRequired

codestringRequired

is_defaultbooleanRequired

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/bypasses

POST /api/v2/bypasses HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": "text",
  "language": "text",
  "code": "text"
}

{
  "id": 1,
  "name": "text",
  "authors": [
    {
      "name": "text",
      "handle": "text",
      "link": "text"
    }
  ],
  "language": "text",
  "code": "text",
  "is_default": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Reset Bypasses

post

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

post/api/v2/bypasses/reset

POST /api/v2/bypasses/reset HTTP/1.1
Accept: */*

No content

Reload Bypasses

post

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

post/api/v2/bypasses/reload

POST /api/v2/bypasses/reload HTTP/1.1
Accept: */*

No content