post¶

lsst.verify.squash.post(api_url, api_endpoint, json_doc=None, timeout=None, version=None, access_token=None)[source]¶

POST a JSON document to SQUASH.

Parameters:

api_url : str

Root URL of the SQUASH API. For example, 'https://squash.lsst.codes/api'.

api_endpoint : str

Name of the API endpoint to post to.

json_doc : dict

A JSON-serializable object.

timeout : float, optional

Request timeout. The value of get_default_timeout is used by default.

version : str, optional

API version. The value of get_default_api_version is used by default.

access_token : str, optional

Access token (see get_access_token). Not required when a POST is done to the API authorization endpoint.

Returns:

response : requests.Response

Response object. Obtain JSON content with response.json().

Raises:

requests.exceptions.RequestException

Raised if the HTTP request fails.