162 lines
2.5 KiB
PHP
162 lines
2.5 KiB
PHP
=================
|
|
Clients (clients)
|
|
=================
|
|
|
|
Clients allow freezer schedulers or users to create a client to be able to
|
|
create, update, show or delete job. The client is required to record you
|
|
backups on freezer api.
|
|
|
|
Lists clients
|
|
=============
|
|
|
|
.. rest_method:: GET /v1/clients
|
|
|
|
Lists clients.
|
|
|
|
This operation lists clients.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes:
|
|
|
|
- Unauthorized (401)
|
|
- Forbidden (403)
|
|
|
|
Query Parameters
|
|
-----------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit: limit
|
|
- offset: marker
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- clients: clients
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/clients-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Creates Client
|
|
==============
|
|
|
|
.. rest_method:: POST /v1/clients
|
|
|
|
Creates a client.
|
|
|
|
This operation creates a new client.
|
|
|
|
Normal response codes: 201
|
|
|
|
Error response codes:
|
|
|
|
- Syntax Error (753)
|
|
- BadRequest (400)
|
|
- Unauthorized (401)
|
|
- ServiceUnavailable (503)
|
|
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- hostname: hostname
|
|
- uuid: uuid
|
|
- client_id: client_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/clients-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- client_id: client_id
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/clients-create-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show clients
|
|
============
|
|
|
|
.. rest_method:: GET /v1/clients/{client_id}
|
|
|
|
Show clients.
|
|
|
|
This operation shows a certain client . It displays all client details.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes:
|
|
|
|
- Unauthorized (401)
|
|
- Forbidden (403)
|
|
|
|
Query Parameters
|
|
-----------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- client_id: client_id_path
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id
|
|
- client_id: client_id
|
|
- hostname: hostname
|
|
- uuid: uuid
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/client-get-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete clients
|
|
==============
|
|
|
|
.. rest_method:: DELETE /v1/clients/{client_id}
|
|
|
|
Delete clients.
|
|
|
|
This operation deletes a certain client.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes:
|
|
|
|
- Unauthorized (401)
|
|
- Forbidden (403)
|
|
|
|
Query Parameters
|
|
-----------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- client_id: client_id_path
|
|
|
|
There is no response for this operation.
|