vulnerability#

Autogenerated API

argus_api.lib.assets.v1.vulnerability.add_asset_vulnerability(includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, hostID: str = None, vulnerabilityID: str = None, references: str = None, observationReferences: str = None, name: str = None, description: str = None, observationDescription: str = None, conclusion: str = None, solution: str = None, rawOutput: str = None, cvss: float = None, severity: str = None, properties: dict = None, exploitAvailable: bool = None, source: str = None, socket: str = None, exploitAvailableTimestamp: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Creates a new AssetVulnerability. (PUBLIC)

Parameters

  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default true)

  • includeConclusion (bool) – Include vulnerability conclusion in result (default true)

  • includeSolution (bool) – Include vulnerability solution in result (default true)

  • hostID (str) – Specify parent host.

  • vulnerabilityID (str) – Identifier of vulnerability (e.g. plug-in ID from vulnerability scanner). => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • references (list) – References to vulnerability (e.g. CVE number).

  • observationReferences (list) – References specific to this vulnerability. May contain customer specific information. Will be merged with references if also present.

  • name (str) – Name of vulnerability. Will be sanitized and no line break allowed.

  • description (str) – Description of vulnerability. Will be sanitized.

  • observationDescription (str) – Description specific to this vulnerability. May contain customer specific information. Will be sanitized.Will be concatenated with description if also present.

  • conclusion (str) – Short summary of vulnerability. Will be sanitized.

  • solution (str) – How to fix vulnerability. Will be sanitized.

  • rawOutput (str) – Raw output from vulnerability scan. Will be sanitized.

  • cvss (float) – CVSS score of vulnerability (range from 0 to 10).

  • severity (str) – Severity level of vulnerability.

  • properties (dict) – Custom user-defined properties. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • exploitAvailable (bool) – Set whether an exploit is available for the vulnerability.

  • source (str) – Source of the request. (default USER)

  • socket (str) – Specify socket string of the vulnerability (e.g. tcp/80), or omit if not bound to a socket.

  • exploitAvailableTimestamp (int) – Set the timestamp when the exploit became available. Setting this value also expects having exploitAvailable as ‘true’ or setting it with this request. If using with exploitAvailable with value ‘true, then setting/leaving it to 0 will use current timestamp. (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.delete_asset_vulnerability(id: str, source: str = 'USER', includeRawOutput: bool = True, includeConclusion: bool = True, includeSolution: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Marks an AssetVulnerability as deleted. (PUBLIC)

Parameters

  • id (str) – AssetVulnerability ID

  • source (str) – Request source (default USER)

  • includeRawOutput (bool) – Include raw output in response

  • includeConclusion (bool) – Include conclusion in response

  • includeSolution (bool) – Include solution in response

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.get_asset_vulnerability(id: str, includeRawOutput: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns an AssetVulnerability identified by its ID. (PUBLIC)

Parameters

  • id (str) – AssetVulnerability ID

  • includeRawOutput (bool) – Include raw output

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.reopen_asset_vulnerability(id: str, includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, source: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Reopen a resolved AssetVulnerability. (PUBLIC)

Parameters

  • id (str) – AssetVulnerability ID

  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default true)

  • includeConclusion (bool) – Include vulnerability conclusion in result (default true)

  • includeSolution (bool) – Include vulnerability solution in result (default true)

  • source (str) – Source of the request. (default USER)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.resolve_asset_vulnerability(id: str, includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, resolution: str = None, resolutionExpiryTimestamp: str = None, comment: str = None, source: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Resolves an AssetVulnerability. (PUBLIC)

Parameters

  • id (str) – AssetVulnerability ID

  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default true)

  • includeConclusion (bool) – Include vulnerability conclusion in result (default true)

  • includeSolution (bool) – Include vulnerability solution in result (default true)

  • resolution (str) – Specify resolution reason.

  • resolutionExpiryTimestamp (str) – When will the current resolution expire (0 means no expiry). Allows unix timestamp (milliseconds), ISO timestamp, or relative time values. See https://docs.mnemonic.no/x/AQDXAQ (default 0)

  • comment (str) – Comment on why the vulnerability is resolved. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • source (str) – Source of the request. (default USER)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.search_asset_vulnerabilities(name: str = None, keywords: str = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: str = None, serviceID: str = None, businessProcessID: str = None, ipRange: str = None, applicationPort: int = None, applicationProtocol: str = None, cpe: str = None, hostCPE: str = None, applicationCPE: str = None, countTimeout: int = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, startTimestamp: str = None, endTimestamp: str = None, minimumCvss: float = None, maximumCvss: float = None, severity: str = None, resolutionCode: str = None, vulnerabilityReference: str = None, id: str = None, vulnerabilityID: str = None, timeFieldStrategy: str = None, keywordFieldStrategy: str = None, includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a set of AssetVulnerabilities defined by an AssetVulnerabilitySearchCriteria. (PUBLIC)

Parameters

  • name (list) – Restrict search to specific asset name

  • keywords (list) – Search for keywords.

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)

  • hostID (list) – Restrict search to specific host UUIDs.

  • serviceID (list) – Restrict search to specific service UUIDs.

  • businessProcessID (list) – Restrict search to specific business process UUIDs.

  • ipRange (str) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.

  • applicationPort (list) – Restrict to applications listening on specific ports.

  • applicationProtocol (list) – Restrict to applications by transport protocol name.

  • cpe (str) – Restrict to applications or hosts by CPE.

  • hostCPE (str) – Restrict to hosts by CPE.

  • applicationCPE (str) – Restrict to applications by CPE.

  • countTimeout (int) – Max wait in seconds for count query, if max wait passed and count query still executing the query; or -1 is set to indicate do not count, then the query will be cancelled and return count -1. Default value 0 means execute as long as service allows, -1 means do not count, max value is 30 (seconds).

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • startTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).

  • endTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).

  • minimumCvss (float) – Restrict search to vulnerabilities with CVSS score at least this high.

  • maximumCvss (float) – Restrict search to vulnerabilities with CVSS score no more than this.

  • severity (list) – Restrict search to specified severity levels.

  • resolutionCode (list) – Restrict search to specific resolution codes.

  • vulnerabilityReference (list) – Restrict to vulnerabilities identified by vulnerability reference.

  • id (list) – Restrict to vulnerabilities identified by ID (UUID).

  • vulnerabilityID (list) – Restrict to vulnerabilities identified by vulnerability ID.

  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).

  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default false)

  • includeConclusion (bool) – Include vulnerability conclusion in result (default false)

  • includeSolution (bool) – Include vulnerability solution in result (default false)

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.search_asset_vulnerabilities_simplified(keywords: str = None, keywordField: str = None, name: str = None, hostID: str = None, serviceID: str = None, businessProcessID: str = None, customerID: int = None, ip: str = None, port: int = None, protocol: str = None, cpe: str = None, vulnID: str = None, vulnRef: str = None, resolutionCode: str = None, severity: str = None, includeFlag: str = None, excludeFlag: str = None, sortBy: str = None, countTimeout: int = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns as set of AssetVulnerabilities defined by query parameters. (PUBLIC)

Parameters

  • keywords (list) – Search by keywords

  • keywordField (list) – Set field strategy for keyword search

  • name (list) – Search by name

  • hostID (list) – Search by HostAsset ID

  • serviceID (list) – Search by ServiceAsset ID

  • businessProcessID (list) – Search by BusinessProcess ID

  • customerID (list) – Search by customer ID

  • ip (list) – Search by IP range

  • port (list) – Search by application port

  • protocol (list) – Search by application protocol

  • cpe (list) – Search by CPE

  • vulnID (list) – Search by vulnerability ID

  • vulnRef (list) – Search by vulnerability reference

  • resolutionCode (list) – Search by resolution code

  • severity (list) – Search by Vulnerability Severity

  • includeFlag (list) – Include certain BusinessProcesses in the search result based on set flags

  • excludeFlag (list) – Exclude certain BusinessProcesses from the search result based on set flags

  • sortBy (list) – Sort search result

  • countTimeout (int) – Max wait in seconds for count query. Value 0 means execute as long as service allows, -1 means do not count, max value is 30 (seconds).

  • limit (int) – Maximum number of returned results

  • keywordMatch (str) – Set match strategy for keyword search

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.search_asset_vulnerability_statistics(name: str = None, keywords: str = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: str = None, serviceID: str = None, businessProcessID: str = None, ipRange: str = None, applicationPort: int = None, applicationProtocol: str = None, cpe: str = None, hostCPE: str = None, applicationCPE: str = None, countTimeout: int = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, startTimestamp: str = None, endTimestamp: str = None, minimumCvss: float = None, maximumCvss: float = None, severity: str = None, resolutionCode: str = None, vulnerabilityReference: str = None, id: str = None, vulnerabilityID: str = None, timeFieldStrategy: str = None, keywordFieldStrategy: str = None, includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, groupBy: str = None, values: str = None, resolution: int = None, cutoff: int = None, cutoffValue: str = None, includeOthers: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch asset vulnerability statistics base on criteria (PUBLIC)

Parameters

  • name (list) – Restrict search to specific asset name

  • keywords (list) – Search for keywords.

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)

  • hostID (list) – Restrict search to specific host UUIDs.

  • serviceID (list) – Restrict search to specific service UUIDs.

  • businessProcessID (list) – Restrict search to specific business process UUIDs.

  • ipRange (str) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.

  • applicationPort (list) – Restrict to applications listening on specific ports.

  • applicationProtocol (list) – Restrict to applications by transport protocol name.

  • cpe (str) – Restrict to applications or hosts by CPE.

  • hostCPE (str) – Restrict to hosts by CPE.

  • applicationCPE (str) – Restrict to applications by CPE.

  • countTimeout (int) – Max wait in seconds for count query, if max wait passed and count query still executing the query; or -1 is set to indicate do not count, then the query will be cancelled and return count -1. Default value 0 means execute as long as service allows, -1 means do not count, max value is 30 (seconds).

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • startTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).

  • endTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).

  • minimumCvss (float) – Restrict search to vulnerabilities with CVSS score at least this high.

  • maximumCvss (float) – Restrict search to vulnerabilities with CVSS score no more than this.

  • severity (list) – Restrict search to specified severity levels.

  • resolutionCode (list) – Restrict search to specific resolution codes.

  • vulnerabilityReference (list) – Restrict to vulnerabilities identified by vulnerability reference.

  • id (list) – Restrict to vulnerabilities identified by ID (UUID).

  • vulnerabilityID (list) – Restrict to vulnerabilities identified by vulnerability ID.

  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).

  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default false)

  • includeConclusion (bool) – Include vulnerability conclusion in result (default false)

  • includeSolution (bool) – Include vulnerability solution in result (default false)

  • groupBy (list) – Specify which fields will be grouped by in stats

  • values (list) – Specify which values will be included in stats (default vulnerabilities)

  • resolution (int) – Stats resolution period in milliseconds, if is 0 means to generate non-timeline statistics

  • cutoff (int) – Reduce stats keys to the cutoff amount of keys that has largest hit count, default 0 means no reduce

  • cutoffValue (str) – Specify which value to be cutoff on (default vulnerabilities)

  • includeOthers (bool) – If reduce (cutoff >0), true means remaining keys (other than cutoff keys) are collected into an “other” key, default false

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.vulnerability.update_asset_vulnerability(id: str, includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, addReferences: str = None, addObservationReferences: str = None, deleteReferences: str = None, deleteObservationReferences: str = None, name: str = None, description: str = None, observationDescription: str = None, conclusion: str = None, solution: str = None, rawOutput: str = None, cvss: float = None, severity: str = None, addProperties: dict = None, deleteProperties: str = None, exploitAvailable: bool = None, source: str = None, exploitAvailableTimestamp: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Updates an existing AssetVulnerability. (PUBLIC)

Parameters

  • id (str) – AssetVulnerability ID

  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default true)

  • includeConclusion (bool) – Include vulnerability conclusion in result (default true)

  • includeSolution (bool) – Include vulnerability solution in result (default true)

  • addReferences (list) – Add references to vulnerability (e.g. CVE number).

  • addObservationReferences (list) – Add references specific to this vulnerability observation. May contain customer specific information. Will be merged with references if also present.

  • deleteReferences (list) – Delete references from vulnerability.

  • deleteObservationReferences (list) – Delete references specific to this vulnerability.

  • name (str) – Change vulnerability name. Will be sanitized and no line break allowed.

  • description (str) – Change vulnerability description. Will be sanitized.

  • observationDescription (str) – Change description specific to this vulnerability observation. May contain customer specific information. Will be sanitized. Will be concatenated with description if also present.

  • conclusion (str) – Change vulnerability summary. Will be sanitized.

  • solution (str) – Change vulnerability solution. Will be sanitized.

  • rawOutput (str) – Change raw output from vulnerability scan. Will be sanitized.

  • cvss (float) – Change CVSS score of vulnerability (range from 0 to 10).

  • severity (str) – Change severity level of vulnerability.

  • addProperties (dict) – Add custom properties (updates a property if key already exists). => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • deleteProperties (list) – Delete custom properties by key.

  • exploitAvailable (bool) – Update whether an exploit is available for the vulnerability.

  • source (str) – Source of the request. (default USER)

  • exploitAvailableTimestamp (int) – Set or update the timestamp when the exploit became available. Setting this value also expects having exploitAvailable as ‘true’ or setting it with this request. If using with exploitAvailable with value ‘true, then setting/leaving it to 0 will use current timestamp. (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON