The config API endpoint is a special case. Because we're using Kohana's config classes under the hood we only really have 2 operations: get - HTTP GET - and set - HTTP PUT. You can use PUT to both create or update a config item.
The config API does not support POST.
METHOD: POST
ENDPOINT: /api/v2/config/
Listing all config entries
METHOD: GET
ENDPOINT: /api/v2/config/:group
AUTHENTICATED: No
Name | Type | Description |
---|---|---|
group | Optional | The group name to return config entries for |
GET https://ushv3.dev/api/v2/config
|
GET https://ushv3.dev/api/v2/config/test
|
Get a single config entry
METHOD: GET
ENDPOINT: /api/v2/config/:group/:id
AUTHENTICATED: Yes
Name | Type | Description |
---|---|---|
id | Required | The config key of the config entry |
group | Required | The group name of the config entry |
GET http://ushv3.dev/api/v2/config/site/site_name
|
Update a config entry
METHOD: PUT
ENDPOINT: /api/v2/config/:group/:id
AUTHENTICATED: Yes
Name | Type | Description |
---|---|---|
id | Required | The config key of the config entry being updated. |
group | Required | The group name of the config entry |
PUT http://ushv3.dev/api/v2/config/site/site_name
|
The config API does not support DELETE.
METHOD: DELETE
ENDPOINT: /api/v2/config/:id