API Endpoints

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

get
Authorizations
Responses
200
Successful operation
application/json
get
GET /admin/configurations HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200,
  "data": {
    "configurations": {
      "id": "13da1a6e-a153-461c-9f41-ab3ac58c801e",
      "provider": "AUTH",
      "name": "Resend Email",
      "value": "5",
      "slug": "auth-resend-email"
    }
  }
}
post
Authorizations
Body
providerstring · enumRequiredExample: AUTHPossible values:
namestringRequiredExample: Resend Email
valuestringRequiredExample: 5
Responses
201
Successful operation
application/json
ResponseanyExample: {"statusCode":201}
post
POST /admin/configurations HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "provider": "AUTH",
  "name": "Resend Email",
  "value": "5"
}
{
  "statusCode": 201
}
get
Authorizations
Path parameters
idstringRequiredExample: df5272ac-54be-4c11-ab4b-d1d69f61a7f9
Responses
200
Successful operation
application/json
get
GET /admin/configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200,
  "data": {
    "id": "13da1a6e-a153-461c-9f41-ab3ac58c801e",
    "provider": "AUTH",
    "name": "Resend Email",
    "value": "5",
    "slug": "auth-resend-email"
  }
}
put
Authorizations
Path parameters
idstringRequiredExample: df5272ac-54be-4c11-ab4b-d1d69f61a7f9
Body
providerstring · enumOptionalExample: AUTHPossible values:
namestringOptionalExample: Resend Email
valuestringOptionalExample: 3
Responses
200
Successful operation
application/json
ResponseanyExample: {"statusCode":200}
put
PUT /admin/configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "provider": "AUTH",
  "name": "Resend Email",
  "value": "3"
}
{
  "statusCode": 200
}
delete
Authorizations
Path parameters
idstringRequiredExample: df5272ac-54be-4c11-ab4b-d1d69f61a7f9
Responses
200
Successful operation
application/json
ResponseanyExample: {"statusCode":200}
delete
DELETE /admin/configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200
}

Last updated

Was this helpful?