API Endpoints

Only Admins and Super Admins can create / read / update / delete values with the API endpoints.

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

get

/admin/configurations

HTTPcURLJavaScriptPython

GET /admin/configurations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200,
  "data": {
    "configurations": {
      "id": "13da1a6e-a153-461c-9f41-ab3ac58c801e",
      "provider": "AUTH",
      "name": "Resend Email",
      "value": "5",
      "slug": "auth-resend-email"
    }
  }
}

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

providerstring · enumRequiredExample: AUTHPossible values:

namestringRequiredExample: Resend Email

valuestringRequiredExample: 5

Responses

201

Successful operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

409

The element already exists

application/json

post

/admin/configurations

HTTPcURLJavaScriptPython

POST /admin/configurations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "provider": "AUTH",
  "name": "Resend Email",
  "value": "5"
}

{
  "statusCode": 201
}

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: df5272ac-54be-4c11-ab4b-d1d69f61a7f9

Responses

200

Successful operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

The element was not found

application/json

get

/admin/configurations/{id}

HTTPcURLJavaScriptPython

GET /admin/configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200,
  "data": {
    "id": "13da1a6e-a153-461c-9f41-ab3ac58c801e",
    "provider": "AUTH",
    "name": "Resend Email",
    "value": "5",
    "slug": "auth-resend-email"
  }
}

put

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: df5272ac-54be-4c11-ab4b-d1d69f61a7f9

Body

application/json

providerstring · enumOptionalExample: AUTHPossible values:

namestringOptionalExample: Resend Email

valuestringOptionalExample: 3

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

The element was not found

application/json

409

The element already exists

application/json

put

/admin/configurations/{id}

HTTPcURLJavaScriptPython

PUT /admin/configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "provider": "AUTH",
  "name": "Resend Email",
  "value": "3"
}

{
  "statusCode": 200
}

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: df5272ac-54be-4c11-ab4b-d1d69f61a7f9

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

The element was not found

application/json

delete

/admin/configurations/{id}

HTTPcURLJavaScriptPython

DELETE /admin/configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200
}