Configurations Endpoints
About
Here we list all the available endpoints from Leaf's Configuration API. To call them easily, we recommend using Leaf's Postman collection.
All HTTP methods should be prepended by this service's endpoint:
This service has the following endpoints available:
Description | Endpoints |
---|---|
Get API Owner's Configuration | GET /configs |
Get Leaf User's Configuration | GET /configs/{leafUserId} |
Create Leaf User's Configuration | POST /configs/{leafUserId} |
Update API Owner's Configuration | PATCH /configs |
Update Leaf User's Configuration | PATCH /configs/{leafUserId} |
Delete Leaf User's Configuration | DELETE /configs/{leafUserId} |
Endpoints
Get API Owner's Configuration
 GET /configs
Gets the configuration of the API Owner.
- cURL
- Python
- JavaScript
Response
A JSON containing the configuration of the API Owner.
Get Leaf User's Configuration
 GET configs/{leafUserId}
Gets the configuration of a Leaf User.
- cURL
- Python
- JavaScript
Response
A JSON containing the configuration of the Leaf User.
Create Leaf User's Configuration
 POST /configs/{leafUserId}
Creates the Configuration for the Leaf User leafUserId
. A request body must be provided
containing the configurations to be set. All entries are optional, any missing configuration will be inherited from the API Owner's Configuration.
Request body example:
- cURL
- Python
- JavaScript
Response
A JSON containing the configuration of the Leaf User.
Update API Owner's Configuration
 PATCH /configs
Updates the specified fields of Configuration for the API Owner. A request body must be provided containing the configurations to be set. All entries are optional.
Request body example:
- cURL
- Python
- JavaScript
Response
A JSON containing the configuration of the API Owner.
Update Leaf User's Configuration
 PATCH /configs/{leafUserId}
Updates the specified fields of Configuration for the Leaf User leafUserId
. A resquest body must be provided containing the configurations to be set. All entries are optional.
Request body example:
- cURL
- Python
- JavaScript
Response
A JSON containing the configuration of the Leaf User.
Delete Leaf User's Configuration
 DELETE /configs/{leafUserId}
Deletes the Configuration from the Leaf User leafUserId
. Until a new Configuration is created, the Leaf User will inherit all configurations from the API Owner.
- cURL
- Python
- JavaScript