Endpoints

class Endpoints(session_kwargs, client, return_type='raw')

Civis API /endpoints endpoint:

import civis
client = civis.APIClient()
# Call client.endpoints.<method>(<arguments>) to make a request, e.g.:
client.endpoints.get(...)

Methods

`get`(*[, openapi_version])	List API endpoints
`list`(*[, openapi_version])	List API endpoints

get(*, openapi_version: str = None) → Response

List API endpoints

API URL: GET /endpoints

Parameters:

openapi_versionstr, optional: If specified, return the spec in the given OpenAPI version format instead of Swagger 2.0. Supported value: ‘3.0’.

Returns:

None: Response code 200: success

list(*, openapi_version: str = None) → ListResponse

List API endpoints

API URL: GET /endpoints

Warning

The method name <client>.endpoints.list is deprecated and will be removed at civis-python v3.0.0 (no release timeline yet). Please switch to <client>.endpoints.get for the same method.

Parameters:

openapi_versionstr, optional: If specified, return the spec in the given OpenAPI version format instead of Swagger 2.0. Supported value: ‘3.0’.

Returns:

None: Response code 200: success