API Endpoints

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

PreviousDB Configuration Table NextOrchestrator

Last updated 1 year ago

Was this helpful?

get

/admin/configurations

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/configurations' \
  --header 'Authorization: Bearer JWT'

200

401

403

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

Successful operation

post

/admin/configurations

Authorizations

Body

namestringrequired

Example: Resend Email

valuestringrequired

Example: 5

providerstring · enumrequired

Example: AUTH

Options: AUTH

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/configurations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Resend Email","value":"5","provider":"AUTH"}'

201

400

401

403

409

{
  "statusCode": 201
}

Successful operation

get

/admin/configurations/{id}

Authorizations

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/configurations/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

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

Successful operation

put

/admin/configurations/{id}

Authorizations

Path parameters

idstringrequired

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

Body

namestring

Example: Resend Email

valuestring

Example: 3

providerstring · enum

Example: AUTH

Options: AUTH

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/admin/configurations/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Resend Email","value":"3","provider":"AUTH"}'

200

400

401

403

404

409

{
  "statusCode": 200
}

Successful operation

delete

/admin/configurations/{id}

Authorizations

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/configurations/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

{
  "statusCode": 200
}

Successful operation