pykazoo.restrequest

class pykazoo.restrequest.RestRequest(api_url, auth_token=None, rest_client=<module 'requests' from '/home/docs/checkouts/readthedocs.org/user_builds/pykazoo/envs/latest/local/lib/python2.7/site-packages/requests/__init__.pyc'>)

Makes a request to 2600hz Kazoo API using HTTP.

Parameters:

• api_url (str, None) – The Kazoo API URL (ex: http://localhost:8000/v2).
• auth_token (str, None) – The auth token to send in the header. Should be None if authentication is not used.
• rest_client (requests) – The module used to make requests. (optional, default: requests)

delete(action, content_type=None)

Performs a Kazoo API DELETE request.

Parameters:

• action (str) – The Kazoo API Action (example: /accounts/{id}).
• content_type (str) – The content type for the get request. Will default to JSON if left unset.

Returns:

Response Content.

Return type:

dict

get(action, params=None, content_type=None)

Performs a Kazoo API GET request.

Parameters:

• action (str) – The Kazoo API Action (example: /accounts/{id}).
• params (dict, None) – The query string parameters (example: filters).
• content_type (str) – The content type for the get request. Will default to JSON if left unset.

Returns:

Response Content.

Return type:

dict

post(action, data=None, content_type=None)

Performs a Kazoo API POST request.

Parameters:

• action (str) – The Kazoo API Action (example: /accounts/{id}).
• data (dict, None) – The data to POST.
• content_type (str) – The content type for the get request. Will default to JSON if left unset.

Returns:

Response Content.

Return type:

dict

put(action, data=None, content_type=None)

Performs a Kazoo API PUT request.

Parameters:

• action (str) – The Kazoo API Action (example: /accounts/{id}).
• data (dict, None) – The data to PUT.
• content_type (str) – The content type for the get request. Will default to JSON if left unset.

Returns:

Response Content.

Return type:

dict