Files

Markus Makela 59e615eb3c Create initial REST API documentation

The Resources document lists all currently known resources and will be converted
to a list of separate resource documents once the individual resource documents
are done. The Headers and Response Codes document contains a list of request and
response headers and the HTTP return codes. This is a work in progress and will
be expanded upon.

Added initial versions of the filter, monitor, session and user resource
documents. These provide information about various parts of MaxScale and
allow interaction.

All PATCH operations expect a JSON Patch type document in the request
body. Examples modified accordingly.

Add MaxScale resource document which describes the resources that give the
global configuration options and show statistics.

The resources that link to other resources provide values as a list of
relative links. This reduces the amount of sent data when the client
doesn't require all parts of the resource.

Since the updating is not yet implement, it should be stated that the update API
will most likely be modified at some point.

The module resource is similar to `maxadmin show modules` and the log
resource contains status information about logs. The log resource also has
an "action" resource at `/maxscale/logs/flush` which flushes logs to disk
and rotates them.

Added start and stop entry points for services and monitors. Also added
missing service parameters to the list of parameters that can be updated.

The documentation lists listeners as a sub-resource of the
service. This allows the listeners of a particular service to be queried.

2016-11-07 14:20:44 +02:00

1.1 KiB

Raw Blame History

Admin User Resource

Admin users represent administrative users that are able to query and change MaxScale's configuration.

Resource Operations

Get all users

Get all administrative users.

GET /users

Response

Status: 200 OK

[
    {
        "name": "jdoe"
    },
    {
        "name": "dba"
    },
    {
        "name": "admin"
    }
]

#### Supported Request Parameter

- `fields`
- `range`

### Create a user

Create a new administrative user.

PUT /users


### Modifiable Fields

All of the following fields need to be defined in the request body.

|Field    |Type  |Description              |
|---------|------|-------------------------|
|name     |string|Username, consisting of alphanumeric characters|
|password |string|Password for the new user|

{ "name": "foo", "password": "bar" }


#### Response

Status: 204 No Content


### Delete a user

Delete a user. The _:name_ part of the URI must be a valid user name. The user
names are case-insensitive.

DELETE /users/:name


#### Response