profile#

Autogenerated API

argus_api.lib.configurationadmin.v1.profile.attach(profileID: int, artifactID: str, 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 : attach is an alias for attach_artifact. Exists only for backward compatibility - do not use - use attach_artifact instead.

argus_api.lib.configurationadmin.v1.profile.attach_artifact(profileID: int, artifactID: str, 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#

Attach artifact to profile (INTERNAL)

Parameters

  • profileID (int) – ID of profile to attach to

  • artifactID (list) – Hash ID of artifacts to attach

  • 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.profile.attach_artifact_by_name(profileName: str, groupID: str, artifactID: str, version: str, 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#

Attach artifact to profile by profile name and artifact GAV (INTERNAL)

Parameters

  • profileName (str) – Name of profile to attach to

  • groupID (str) – GroupID of artifact to attach

  • artifactID (str) – ArtifactID of artifact to attach

  • version (str) – Version of artifact to attach

  • 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.profile.attach_by_name(profileName: str, groupID: str, artifactID: str, version: str, 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 : attach_by_name is an alias for attach_artifact_by_name. Exists only for backward compatibility - do not use - use attach_artifact_by_name instead.

argus_api.lib.configurationadmin.v1.profile.attach_detach(profileID: int, artifactsToAttach: str = None, artifactsToDetach: 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 : attach_detach is an alias for attach_detach_artifacts. Exists only for backward compatibility - do not use - use attach_detach_artifacts instead.

argus_api.lib.configurationadmin.v1.profile.attach_detach_artifacts(profileID: int, artifactsToAttach: str = None, artifactsToDetach: 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#

Attach and detach artifact to given profile (INTERNAL)

Parameters

  • profileID (int) – ID of profile to detach from

  • artifactsToAttach (list) – List of artifact SHA256 ids to attach

  • artifactsToDetach (list) – List of artifact SHA256 ids to detach

  • 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.profile.create_1(name: str = None, artifactsToAttach: str = None, finalize: 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_1 is an alias for create_code_profile. Exists only for backward compatibility - do not use - use create_code_profile instead.

argus_api.lib.configurationadmin.v1.profile.create_code_profile(name: str = None, artifactsToAttach: str = None, finalize: 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#

Add new code profile (INTERNAL)

Parameters

  • name (str) – The name of the new code profile => [a-zA-Z0-9_:\-.]*

  • artifactsToAttach (list) – List of artifact SHA256 ids to attach to this profile

  • finalize (bool) – If true, finalize immediately upon creation. When finalized, the profile cannot be modified anymore.

  • 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.profile.delete(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 is an alias for delete_code_profile. Exists only for backward compatibility - do not use - use delete_code_profile instead.

argus_api.lib.configurationadmin.v1.profile.delete_code_profile(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#

Mark code profile as deleted (INTERNAL)

Parameters

  • id (int) – ID of profile 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.profile.detach(profileID: int, artifactID: str, 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 : detach is an alias for detach_artifact. Exists only for backward compatibility - do not use - use detach_artifact instead.

argus_api.lib.configurationadmin.v1.profile.detach_artifact(profileID: int, artifactID: str, 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#

Detach artifact to profile (INTERNAL)

Parameters

  • profileID (int) – ID of profile to detach from

  • artifactID (str) – Hash ID of artifact to detach

  • 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.profile.detach_artifact_by_g_a(profileName: str, groupID: str, artifactID: str, 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 : detach_artifact_by_g_a is an alias for detach_artifact_by_gav. Exists only for backward compatibility - do not use - use detach_artifact_by_gav instead.

argus_api.lib.configurationadmin.v1.profile.detach_artifact_by_gav(profileName: str, groupID: str, artifactID: str, 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#

Detach artifact from profile by profile name and artifact GAV (INTERNAL)

Parameters

  • profileName (str) – Name of profile to detach from

  • groupID (str) – GroupID of artifact to detach

  • artifactID (str) – ArtifactID of artifact to detach

  • 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.profile.detach_artifact_by_name(profileName: str, groupID: str, artifactID: str, version: str, 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#

Detach artifact from profile by profile name and artifact GAV (INTERNAL)

Parameters

  • profileName (str) – Name of profile to detach from

  • groupID (str) – GroupID of artifact to detach

  • artifactID (str) – ArtifactID of artifact to detach

  • version (str) – Version of artifact to detach

  • 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.profile.detach_by_artifact_by_g_a(profileName: str, groupID: str, artifactID: str, 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 : detach_by_artifact_by_g_a is an alias for detach_artifact_by_gav. Exists only for backward compatibility - do not use - use detach_artifact_by_gav instead.

argus_api.lib.configurationadmin.v1.profile.detach_by_name(profileName: str, groupID: str, artifactID: str, version: str, 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 : detach_by_name is an alias for detach_artifact_by_name. Exists only for backward compatibility - do not use - use detach_artifact_by_name instead.

argus_api.lib.configurationadmin.v1.profile.duplicate(id: int, name: str, 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 is an alias for duplicate_code_profile. Exists only for backward compatibility - do not use - use duplicate_code_profile instead.

argus_api.lib.configurationadmin.v1.profile.duplicate_code_profile(id: int, name: str, 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 existing code profile (INTERNAL)

Parameters

  • id (int) – ID of profile to duplicate

  • name (str) – Name of new profile

  • 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.profile.get_by_id_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 : get_by_id_1 is an alias for get_code_profile_by_id. Exists only for backward compatibility - do not use - use get_code_profile_by_id instead.

argus_api.lib.configurationadmin.v1.profile.get_by_name(name: str, 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 : get_by_name is an alias for get_code_profile_by_name. Exists only for backward compatibility - do not use - use get_code_profile_by_name instead.

argus_api.lib.configurationadmin.v1.profile.get_code_profile_by_id(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#

Get code profile by ID (INTERNAL)

Parameters

  • id (int) – ID of profile 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

argus_api.lib.configurationadmin.v1.profile.get_code_profile_by_name(name: str, 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#

Get code profile by name (INTERNAL)

Parameters

  • name (str) – Name of profile 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

argus_api.lib.configurationadmin.v1.profile.list_1(orderDesc: bool = None, limit: int = 25, orderBy: str = 'name', 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#

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

argus_api.lib.configurationadmin.v1.profile.list_code_profiles(orderDesc: bool = None, limit: int = 25, orderBy: str = 'name', 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#

List code profiles (INTERNAL)

Parameters

  • orderDesc (bool) – Sort results descending

  • limit (int) – Limit results

  • orderBy (str) – Sort results

  • offset (int) – Offset 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.profile.search_1(searchString: str = None, usingArtifact: str = None, includeArtifacts: bool = None, includeCreatedTimestamp: bool = None, includeLastUpdatedTimestamp: bool = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, startTimestamp: str = None, endTimestamp: str = 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#

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

argus_api.lib.configurationadmin.v1.profile.search_code_profiles(searchString: str = None, usingArtifact: str = None, includeArtifacts: bool = None, includeCreatedTimestamp: bool = None, includeLastUpdatedTimestamp: bool = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, startTimestamp: str = None, endTimestamp: str = 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#

Search code profiles (INTERNAL)

Parameters

  • searchString (str) –

  • usingArtifact (list) –

  • includeArtifacts (bool) –

  • includeCreatedTimestamp (bool) –

  • includeLastUpdatedTimestamp (bool) –

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

  • startTimestamp (str) – Restrict search to data after this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • endTimestamp (str) – Restrict search to data before this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • 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.configurationadmin.v1.profile.update(id: int, name: str = None, finalized: bool = None, useForUnknown: bool = None, setAsDefault: 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 : update is an alias for update_code_profile. Exists only for backward compatibility - do not use - use update_code_profile instead.

argus_api.lib.configurationadmin.v1.profile.update_code_profile(id: int, name: str = None, finalized: bool = None, useForUnknown: bool = None, setAsDefault: 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#

Update code profile (INTERNAL)

Parameters

  • id (int) – ID of profile to update

  • name (str) – New name of code profile. => [a-zA-Z0-9_:\-.]*

  • finalized (bool) – If true, finalize this code profile. Once finalized, the profile cannot be modified anymore.

  • useForUnknown (bool) – DEPRECATED: Not in use

  • setAsDefault (bool) – DEPRECATED: Not in use

  • 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