instance#

Autogenerated API

argus_api.lib.configurationadmin.v1.instance.add_comment_1(id: int, 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#

DEPRECATED : add_comment_1 is an alias for add_instance_comment. Exists only for backward compatibility - do not use - use add_instance_comment instead.

argus_api.lib.configurationadmin.v1.instance.add_instance_comment(id: int, 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#

Add a comment to configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to comment

  • 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.configurationadmin.v1.instance.create_3(templateID: int = None, hostID: int = None, parentID: int = None, pinnedTemplateRevision: int = None, information: str = None, properties: dict = None, identifiers: dict = None, codeProfile: str = None, daytimeMonitored: 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#

DEPRECATED : create_3 is an alias for create_instance. Exists only for backward compatibility - do not use - use create_instance instead.

argus_api.lib.configurationadmin.v1.instance.create_instance(templateID: int = None, hostID: int = None, parentID: int = None, pinnedTemplateRevision: int = None, information: str = None, properties: dict = None, identifiers: dict = None, codeProfile: str = None, daytimeMonitored: 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#

Create new configuration instance (INTERNAL)

Parameters

  • templateID (int) – The ID of the template to use for this instance

  • hostID (int) – The ID of the host to run this instance on

  • parentID (int) – If set, define a parent instance ID which this instance should run below.

  • pinnedTemplateRevision (int) – If set, pin this instance to the specified template revision. Revision 0 means use latest revision.

  • information (str) – Informational text. Will be default sanitized. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • properties (dict) – Configuration properties to set for this instance. Will override any conflicting properties set on host or template.

  • identifiers (dict) – Identifiers to set for this instance. Use this to differentiate between multiple instances of the same template on the same host.

  • codeProfile (str) – The code profile to use for this instance. => [a-zA-Z0-9_:\-.]*

  • daytimeMonitored (bool) – If true, mark this instance as a DAYTIME_MONITORED host. (default false)

  • 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.configurationadmin.v1.instance.delete_2(id: int, 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#

DEPRECATED : delete_2 is an alias for delete_instance. Exists only for backward compatibility - do not use - use delete_instance instead.

argus_api.lib.configurationadmin.v1.instance.delete_instance(id: int, 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#

Delete configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to delete

  • 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.configurationadmin.v1.instance.disable_instance_monitoring(id: int, 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#

Disable monitoring of configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to disable monitoring on

  • 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.configurationadmin.v1.instance.disable_monitoring_1(id: int, 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#

DEPRECATED : disable_monitoring_1 is an alias for disable_instance_monitoring. Exists only for backward compatibility - do not use - use disable_instance_monitoring instead.

argus_api.lib.configurationadmin.v1.instance.duplicate_host_1(instanceID: int, hostID: 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#

DEPRECATED : duplicate_host_1 is an alias for duplicate_instance. Exists only for backward compatibility - do not use - use duplicate_instance instead.

argus_api.lib.configurationadmin.v1.instance.duplicate_instance(instanceID: int, hostID: 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#

Duplicate a configuration instance (INTERNAL) (INTERNAL)

Parameters

  • instanceID (int) – ID of instance to duplicate

  • hostID (int) – If set, duplicate the instance onto the specified host

  • 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.configurationadmin.v1.instance.enable_instance_monitoring(id: int, 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#

Enable monitoring of configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to enable monitoring on

  • 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.configurationadmin.v1.instance.enable_monitoring_1(id: int, 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#

DEPRECATED : enable_monitoring_1 is an alias for enable_instance_monitoring. Exists only for backward compatibility - do not use - use enable_instance_monitoring instead.

argus_api.lib.configurationadmin.v1.instance.get_instance_configuration_data(id: int, 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 configuration data which is active for this configuration instance (INTERNAL)

Parameters

  • id (int) – ID or shortname of template

  • 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.configurationadmin.v1.instance.get_instance_properties(id: int, 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 configuration instance properties (INTERNAL)

Parameters

  • id (int) – ID of instance

  • 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.configurationadmin.v1.instance.instance_revisions(id: int, offset: int = None, limit: int = 25, 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#

List configuration instance revisions (INTERNAL)

Parameters

  • id (int) – ID of instance to fetch revisions for

  • offset (int) – Offset results

  • limit (int) – Limit 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

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.instance.list_3(offset: int = None, search: str = None, includeComments: bool = None, includeDeleted: bool = None, templateID: int = None, hostID: int = None, limit: int = 25, 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#

DEPRECATED : list_3 is an alias for list_instances. Exists only for backward compatibility - do not use - use list_instances instead.

argus_api.lib.configurationadmin.v1.instance.list_instances(offset: int = None, search: str = None, includeComments: bool = None, includeDeleted: bool = None, templateID: int = None, hostID: int = None, limit: int = 25, 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#

List configuration instances (INTERNAL)

Parameters

  • offset (int) – Offset results

  • search (str) – Limit results to instances matching this searchstring

  • includeComments (bool) – Include comments in output

  • includeDeleted (bool) – Include deleted instances

  • templateID (list) – Limit results to instances with these templates

  • hostID (list) – Limit results to instances on these hosts

  • limit (int) – Limit 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

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.instance.move_instance(instanceID: int, hostID: 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#

Move a configuration instance to another host (INTERNAL)

Parameters

  • instanceID (int) – ID of instance to move

  • hostID (int) – Host to move the instance to

  • 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.configurationadmin.v1.instance.revisions(id: int, offset: int = None, limit: int = 25, 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#

DEPRECATED : revisions is an alias for instance_revisions. Exists only for backward compatibility - do not use - use instance_revisions instead.

argus_api.lib.configurationadmin.v1.instance.schedule_instance_monitoring(id: int, 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#

Schedule downtime for configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to schedule downtime for

  • 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.configurationadmin.v1.instance.schedule_monitoring_1(id: int, 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#

DEPRECATED : schedule_monitoring_1 is an alias for schedule_instance_monitoring. Exists only for backward compatibility - do not use - use schedule_instance_monitoring instead.

argus_api.lib.configurationadmin.v1.instance.search_3(instanceID: int = None, templateID: int = None, hostID: int = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, template: str = None, customer: str = None, instance: int = None, host: str = None, parentID: int = None, codeProfile: str = None, keywords: str = None, masterID: int = None, codeProfileOverride: bool = None, monitoringDisabled: bool = None, inDowntime: bool = None, daytimeMonitored: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, includeComments: bool = None, includeProperties: 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#

DEPRECATED : search_3 is an alias for search_instances. Exists only for backward compatibility - do not use - use search_instances instead.

argus_api.lib.configurationadmin.v1.instance.search_instances(instanceID: int = None, templateID: int = None, hostID: int = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, template: str = None, customer: str = None, instance: int = None, host: str = None, parentID: int = None, codeProfile: str = None, keywords: str = None, masterID: int = None, codeProfileOverride: bool = None, monitoringDisabled: bool = None, inDowntime: bool = None, daytimeMonitored: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, includeComments: bool = None, includeProperties: 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#

Search configuration instances (INTERNAL)

Parameters

  • instanceID (list) –

  • templateID (list) –

  • hostID (list) –

  • 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).

  • template (list) – If set, filter instances by template ID or shortname.

  • customer (list) – If set, filter instances by host customer ID or shortname.

  • instance (list) – If set, filter instances by ID.

  • host (list) – If set, filter instances by host ID or hostname.

  • parentID (list) – If set, filter instances by parent instance ID.

  • codeProfile (list) – If set, filter instances by active code profile.

  • keywords (list) – If set, filter instances matching these keywords.

  • masterID (int) – If set, only include instance revisions of given master. If not set, revisions are excluded.

  • codeProfileOverride (bool) – If true, only return instances with overridden code profile. If false, exclude. If not set, do not filter.

  • monitoringDisabled (bool) – If true, only return instances with disabled monitoring, or whose host has disabled monitoring. If false, exclude. If not set, do not filter.

  • inDowntime (bool) – If true, only return instances which are in scheduled downtime, or whose host is in downtime. If false, exclude. If not set, do not filter.

  • daytimeMonitored (bool) – If true, only return instances which are daytime monitored (either set on the instance, or parent host/instance). If false, exclude. If not set, do not filter.

  • 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.

  • includeComments (bool) – If true, include comments in output. (default false)

  • includeProperties (bool) – If true, include properties in output. (default true)

  • 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.configurationadmin.v1.instance.update_2(id: int, configurationID: int = None, hostID: int = None, parentID: int = None, pinnedTemplateRevision: int = None, information: str = None, daytimeMonitored: bool = None, properties: dict = None, identifiers: dict = None, codeProfile: 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#

DEPRECATED : update_2 is an alias for update_instance. Exists only for backward compatibility - do not use - use update_instance instead.

argus_api.lib.configurationadmin.v1.instance.update_instance(id: int, configurationID: int = None, hostID: int = None, parentID: int = None, pinnedTemplateRevision: int = None, information: str = None, daytimeMonitored: bool = None, properties: dict = None, identifiers: dict = None, codeProfile: 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#

Update configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to update

  • configurationID (int) – DEPRECATED: Deprecated option, it is not allowed to change the template of an existing instance.

  • hostID (int) – DEPRECATED: Deprecated option. Use the /move endpoint to move instance to another host.

  • parentID (int) – DEPRECATED: Deprecated option, it is not allowed to change the parent of an existing instance.

  • pinnedTemplateRevision (int) – If set, pin this instance to the specified template revision. Revision 0 means use latest revision.

  • information (str) – If set, change information field for instance. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • daytimeMonitored (bool) – If set, change the DAYTIME_MONITORED flag on this instance

  • properties (dict) – If set, set these properties for instance. Property with null value will delete existing property.

  • identifiers (dict) – If set, set these identifiers for instance. Identifier with null value will delete existing identifier.

  • codeProfile (str) – Name of code profile to use. If null, do not change. If blank, reset to template profile. => [a-zA-Z0-9_:\-.]*

  • 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.configurationadmin.v1.instance.update_instance_properties(id: int, properties: dict = 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#

Update configuration instance properties (INTERNAL)

Parameters

  • id (int) – ID of instance to update properties on

  • properties (dict) – The properties to update to, null value will clear the property

  • 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.configurationadmin.v1.instance.view_1(id: int, 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#

DEPRECATED : view_1 is an alias for view_instance. Exists only for backward compatibility - do not use - use view_instance instead.

argus_api.lib.configurationadmin.v1.instance.view_instance(id: int, 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 configuration instance (INTERNAL)

Parameters

  • id (int) – ID of instance to fetch

  • 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