Adding helper functions for convenient PUT and PATCH on SDK by seiimonn · Pull Request #586 · splunk/splunk-sdk-python · GitHub

The current SDK does not provide dedicated functions for sending PUT and PATCH requests to endpoints in Splunk. These operations were only possible using the generic request method, which had issues correctly formatting a body payload, especially for form-encoded data.

This change introduces helper functions for PUT and POST requests, along with a new _prepare_request_body_and_url function to streamline body and URL preparation logic. This ensures consistency, reduces redundancy, and resolves issues with incorrect payload formatting when making these requests.

Changes

Added a _prepare_request_body_and_url helper function to handle body preparation and URL encoding for POST and PUT requests.
Added put() and updated post() methods to leverage the helper function.
Ensured proper handling of Content-Type headers for form-encoded data.

Benefits

Simplifies making PUT and PATCH requests directly without needing the generic request method.
Fixes body formatting issues, ensuring payloads are correctly encoded.

Dismissed as stale. Please tell us if the issue persists!

This is still very much sought after by my team. Let me know if you need anything for this to be merged.

Thanks @seiimonn, we'll take a look and get back to you!

Hi @Ickerday - anything I can do to support on this?

Hi

We plan to give this a look, we are going to figure out which way is the best to implement this (we might go with this change) but in the meantime can you rebase this on top of the develop branch?

Thanks, once again i would ask you to rebase this, since i would like to see this being also tested with the tests i have introduced for #683.

Please add in tests/system/test_cre_apps.py TestJSONCustomRestEndpointsSpecialMethodHelpers a test case for PUT and PATCH, i assume they would look the same as test_POST.

Drop that change. It seems to only make the code non-formatted.

I think we should change this example, splunk does not really support PUT/PATCH in its endpoints see: https://help.splunk.com/en/splunk-enterprise/leverage-rest-apis/rest-api-reference/10.0/introduction/endpoints-reference-list (that is the reason there were no such methods in the first place)

I think we should have an example that shows that it is used with custom rest endpoints, something like:

# Call an HTTP endpoint, exposed as Custom Rest Endpoint in a Splunk App.
# PUT /servicesNS/-/app_name/custom_rest_endpoint
service.put(
     app="app_name",
     path_segment="custom_rest_endpoint",
     body=json.dumps({"key": "val"}),
     headers=[("Content-Type", "application/json")],
)

Same here, lets change it, as above.

Suggested change

      
                    :param body: Parameters to be used in the post body. If specified,
          
                    :param body: Parameters to be used in the put body. If specified,

Suggested change

      
                    :param body: Parameters to be used in the post body. If specified,
          
                    :param body: Parameters to be used in the patch body. If specified,

Splunk does not support PUT method in its endpoints, so lets not mention that.

Suggested change

      
                    Some of Splunk's endpoints, such as ``receivers/simple`` and
          
                    ``receivers/stream``, require unstructured data in the PUT body
          
                    and all metadata passed as GET-style arguments. If you provide
          
                    a ``body`` argument to ``put``, it will be used as the PUT
          
                    body, and all other keyword arguments will be passed as
          
                    GET-style arguments in the URL.
          
                    If you provide a ``body`` argument to ``put``, 
          
                    it will be used as the PUT body, and all other 
          
                    keyword arguments will be passed as GET-style 
          
                    arguments in the URL.

Same here.

Ickerday closed this Aug 21, 2025

moschi mentioned this pull request Sep 9, 2025

Add ability to send custom PUT and PATCH requests with JSON body #577

Closed

Ickerday reopened this Sep 9, 2025

seiimonn added 2 commits November 6, 2025 10:02

Adding PUT and PATCH method to Context

a4f32af

Restoring request method

9cb3902

seiimonn force-pushed the develop branch from 8d2a8e1 to 9cb3902 Compare November 6, 2025 10:02

mateusz834 requested changes Nov 17, 2025

View reviewed changes

Ickerday marked this pull request as draft November 17, 2025 15:11

mateusz834 mentioned this pull request Jan 9, 2026

Add patch and put methods to the service #693

Merged

mateusz834 closed this in #693 Jan 9, 2026

-                              message = {"method": method, "headers": all_headers}
+                              path = path + UrlEncoded('?' + body, skip_encode=True)
+                              message = {'method': method,
+                                         'headers': all_headers}

+                      **Example**::
+                          c = binding.connect(...)
+                          c.post('saved/searches', name='boris',
+                                 search='search * earliest=-1m | head 1') == \\
+                              {'body': ...a response reader object...,
+                               'headers': [('content-length', '10455'),
+                                           ('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
+                                           ('server', 'Splunkd'),
+                                           ('connection', 'close'),
+                                           ('cache-control', 'no-store, max-age=0, must-revalidate, no-cache'),
+                                           ('date', 'Fri, 11 May 2012 16:46:06 GMT'),
+                                           ('content-type', 'text/xml; charset=utf-8')],
+                               'reason': 'Created',
+                               'status': 201}
+                          c.post('nonexistant/path') # raises HTTPError
+                          c.logout()
+                          # raises AuthenticationError:
+                          c.put('saved/searches/boris',
+                                 search='search * earliest=-1m | head 1')
+                      """

+                          c = binding.connect(...)
+                          c.post('saved/searches', name='boris',
+                                 search='search * earliest=-1m | head 1') == \\
+                              {'body': ...a response reader object...,
+                               'headers': [('content-length', '10455'),
+                                           ('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
+                                           ('server', 'Splunkd'),
+                                           ('connection', 'close'),
+                                           ('cache-control', 'no-store, max-age=0, must-revalidate, no-cache'),
+                                           ('date', 'Fri, 11 May 2012 16:46:06 GMT'),
+                                           ('content-type', 'text/xml; charset=utf-8')],
+                               'reason': 'Created',
+                               'status': 201}
+                          c.post('nonexistant/path') # raises HTTPError
+                          c.logout()
+                          # raises AuthenticationError:
+                          c.patch('saved/searches/boris',
+                                 search='search * earliest=-1m | head 1')

+                      :type headers: ``list`` of 2-tuples.
+                      :param query: All other keyword arguments, which are used as query
+                          parameters.
+                      :param body: Parameters to be used in the post body. If specified,

+                      :type headers: ``list`` of 2-tuples.
+                      :param query: All other keyword arguments, which are used as query
+                          parameters.
+                      :param body: Parameters to be used in the post body. If specified,

	:param body: Parameters to be used in the post body. If specified,
	:param body: Parameters to be used in the put body. If specified,

Adding helper functions for convenient PUT and PATCH on SDK by seiimonn · Pull Request #586 · splunk/splunk-sdk-python · GitHub

Repository navigation

Adding helper functions for convenient PUT and PATCH on SDK - #586

Adding helper functions for convenient PUT and PATCH on SDK#586seiimonn wants to merge 2 commits intosplunk:developsplunk/splunk-sdk-python:developfrom seiimonn:developseiimonn/splunk-sdk-python:developCopy head branch name to clipboard

Conversation

seiimonn commented Oct 7, 2024

Changes

Benefits

Uh oh!

Ickerday commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seiimonn commented Aug 21, 2025

Uh oh!

Ickerday commented Sep 9, 2025

Uh oh!

seiimonn commented Oct 27, 2025

Uh oh!

mateusz834 commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mateusz834 commented Nov 12, 2025

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

mateusz834 Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Adding helper functions for convenient PUT and PATCH on SDK#586
seiimonn wants to merge 2 commits into
splunk:developfrom
seiimonn:develop

Ickerday commented Aug 21, 2025 •
edited
Loading

mateusz834 commented Nov 4, 2025 •
edited
Loading