nostaigia/ParaTool huggingface dataset:
name: version_api.VersionApi.get_version
description: Retrieve the current version of the application, including its name and version number in a JSON object.
parameters: type: dict
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: This function retrieves the current security vulnerabilities metrics for a specified project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier of the project for which vulnerabilities metrics are being queried.
version: type: string
description: The specific version of the project to query for vulnerabilities metrics. Version should follow semantic versioning, such as '1.0.0'.
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve detailed information about a specific project based on its name and version number.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier for the project.
version: type: string
description: The version identifier of the project, in the format 'major.minor.patch' (e.g., '1.2.0').
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: Retrieves a badge image representing the policy violations of a specified project and version.
parameters: type: dict
required: project_name
project_version
properties: project_name: type: string
description: The unique name of the project for which the policy violations badge is requested.
project_version: type: string
description: The specific version identifier of the project for which the policy violations badge is requested.
name: bom_api.BomApi.export_project_as_cyclone_dx
description: Exports the dependency metadata of a specified project in the CycloneDX format, which is a standardized format for encoding Bill of Materials (BOM) information.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier of the project for which dependency metadata is to be exported.
format: type: string
description: The output format of the exported data. Supports 'JSON' or 'XML' formats.
enum: JSON
XML
default: JSON
variant: type: string
description: The specific CycloneDX variant to export. Choose between 'inventory' for basic component information or 'withVulnerabilities' to include known vulnerabilities.
enum: inventory
withVulnerabilities
default: inventory
download: type: boolean
description: A flag indicating whether to force download of the resulting BOM as a file. When set to true, the BOM will be downloaded; otherwise, it may be displayed in the browser or API client.
default: no
name: EventSettingsApi.get_built_in_event_specifications
description: Retrieve a list of built-in event specifications using their IDs.
parameters: type: dict
required: ids
properties: ids: type: array
items: type: string
description: A list of event specification IDs to retrieve. Each ID is a string uniquely identifying an event specification.
name: EventSettingsApi.get_event_specification_infos_by_ids
description: Retrieves a summary of all built-in and custom event specifications using their unique identifiers.
parameters: type: dict
required: event_ids
properties: event_ids: type: array
items: type: string
description: An array of event specification identifiers to fetch details for.
include_details: type: boolean
description: Flag to determine whether to include detailed information for each event specification.
default: no
name: EventSettingsApi.get_custom_event_specification
description: Retrieve the specifications for a custom event by its unique identifier.
parameters: type: dict
required: eventSpecificationId
properties: eventSpecificationId: type: string
description: The unique identifier of the custom event specification.
name: get_websites
description: Retrieve a list of all configured websites with their associated settings and metadata.
parameters: type: dict
properties: status_filter: type: string
description: Filter the list by the website's status. For example, active, inactive, or under maintenance.
enum: active
inactive
maintenance
default: active
include_metadata: type: boolean
description: Specify whether to include metadata such as creation date and last updated date for each website.
default: no
name: website_configuration_api.WebsiteConfigurationApi.get_website
description: Retrieves the configuration settings for a specified website by its unique identifier.
parameters: type: dict
required: websiteId
properties: websiteId: type: string
description: The unique identifier of the website whose configuration is to be retrieved.
name: ApplicationSettingsApi.get_service_configs
description: Retrieve a list of all service configurations for the application, including default settings and overrides.
parameters: type: dict
properties: service_name: type: string
description: The name of the specific service to retrieve configurations for, such as 'database' or 'cache'. If omitted, configurations for all services will be returned.
default: all
include_defaults: type: boolean
description: A flag to determine whether to include the application's default service configurations in the response.
default: yes
name: releases_api.ReleasesApi.delete_release
description: Deletes a specified release from the system using its unique identifier.
parameters: type: dict
required: releaseId
properties: releaseId: type: string
description: The unique identifier of the release to be deleted.
name: releases_api.ReleasesApi.post_release
description: Creates a new release record in the system with the provided details.
parameters: type: dict
required: version
project_id
properties: version: type: string
description: The version identifier for the release, following Semantic Versioning, such as '1.0.0'.
project_id: type: integer
description: The unique identifier of the project associated with this release.
description: type: string
description: A brief description of the release and its main features.
default: No description provided.
release_date: type: string
description: The release date in the format 'YYYY-MM-DD'.
name: sli_settings_api.SLISettingsApi.delete_sli_config
description: Deletes a Service Level Indicator (SLI) configuration from the system using the specified identifier. This action is irreversible.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the SLI configuration to be deleted.
name: website_configuration_api.WebsiteConfigurationApi.rename_website
description: Renames an existing website with a new name based on the provided website ID.
parameters: type: dict
required: websiteId
name
properties: websiteId: type: string
description: The unique identifier of the website to be renamed.
name: type: string
description: The new name for the website.
name: website_configuration_api.WebsiteConfigurationApi.create_website
description: This function initializes the configuration for a new website by setting up its name and other essential settings.
parameters: type: dict
required: name
properties: name: type: string
description: The name of the new website to be configured.
name: website_configuration_api.delete_website
description: Deletes a website configuration from the system using the specified website ID.
parameters: type: dict
required: websiteId
properties: websiteId: type: string
description: The unique identifier of the website to be removed.
name: apdex_settings_api.ApdexSettingsApi.create_apdex_configuration
description: Creates a new Apdex configuration for an application, allowing customization of satisfactory, tolerable, and frustrated response time thresholds.
parameters: type: dict
required: application_id
thresholds
properties: application_id: type: string
description: The unique identifier for the application for which Apdex configuration is to be created.
thresholds: type: dict
properties: satisfactory: type: float
description: The maximum response time (in seconds) for a user action to be considered satisfactory.
tolerable: type: float
description: The maximum response time (in seconds) for a user action to be considered tolerable before frustration sets in.
frustrated: type: float
description: The response time (in seconds) at which a user action is considered frustrated, indicating an unsatisfactory experience.
description: Threshold values defining the Apdex score categories.
name: type: string
description: A human-readable name for the Apdex configuration.
default: Default Configuration
enabled: type: boolean
description: A flag to enable or disable this Apdex configuration.
default: yes
name: delete_apdex_configuration
description: Deletes the specified Apdex configuration by its unique identifier.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the Apdex configuration to delete.
name: get_all_apdex_configurations
description: Retrieve a list of all Apdex (Application Performance Index) configurations that define satisfactory thresholds for application response times.
parameters: type: dict
properties: application_id: type: string
description: The unique identifier of the application for which to fetch Apdex settings. If not provided, Apdex settings for all applications will be returned.
default: all
include_thresholds: type: boolean
description: Whether to include the threshold values in the response. If false, only the configuration names and IDs will be returned.
default: yes
name: get_apdex_report
description: Generate an Apdex Report for a specified Apdex ID within a given time range.
parameters: type: dict
required: apdexId
_from
to
properties: apdexId: type: string
description: The unique identifier of the Apdex configuration for which the report is generated.
_from: type: integer
description: The start time for the report as a Unix Timestamp in milliseconds (13 digits), representing the time from which to begin the report data.
to: type: integer
description: The end time for the report as a Unix Timestamp in milliseconds (13 digits), representing the time at which to end the report data.
name: apdex_settings_api.ApdexSettingsApi.create_apdex_configuration
description: Creates a new Apdex configuration by setting the threshold values for satisfactory, tolerable, and frustrated user experience levels.
parameters: type: dict
required: thresholds
properties: thresholds: type: dict
description: Threshold levels for Apdex score calculations.
properties: satisfactory: type: float
description: The threshold for a satisfactory user experience (in seconds).
tolerable: type: float
description: The threshold for a tolerable user experience (in seconds).
frustrated: type: float
description: The threshold beyond which the user experience is considered frustrated (in seconds).
application_id: type: string
description: The unique identifier of the application for which the Apdex configuration is created.
default: default_app_id
enabled: type: boolean
description: A flag to enable or disable the Apdex configuration.
default: yes
name: apdex_settings_api.ApdexSettingsApi.get_all_apdex_configurations
description: Retrieve a list of all Apdex threshold configurations used for applications performance monitoring.
parameters: type: dict
properties: application_id: type: string
description: The unique identifier of the application for which Apdex settings are being retrieved. For example, 'app_12345'.
default: all
active_only: type: boolean
description: A flag to filter the configurations. If set to true, only active Apdex settings are returned.
default: yes
name: EventSettingsApi.restore_mobile_app_alert_config
description: Restores the configuration of mobile app alerts to a previous state using the specified ID. This can be used to revert changes or recover a configuration that was mistakenly altered.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the mobile app alert configuration to be restored.
created: type: string
description: The creation timestamp of the alert configuration in the format 'YYYY-MM-DDTHH:MM:SSZ'.
default: null
name: find_mobile_app_alert_config
description: Retrieves a Mobile App Alert Configuration by its unique ID, including configurations that have been marked as deleted.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the Mobile App Alert Configuration.
validOn: type: string
description: The date when the configuration is considered valid, in the format of 'YYYY-MM-DD'.
default: null
name: find_mobile_app_alert_config_versions
description: Retrieve a list of all versions of a specified Mobile App Alert Configuration, including those that have been deleted, sorted in descending order by their creation date.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the Mobile App Alert Configuration.
name: add_service_config
description: Adds a new service configuration to the application settings, allowing the application to acknowledge and use the service parameters specified.
parameters: type: dict
required: service_name
configurations
properties: service_name: type: string
description: The unique name of the service for which the configuration is being added.
configurations: type: dict
description: A dictionary of key-value pairs representing the configuration settings for the service.
properties: timeout: type: integer
description: The time in seconds before a service request times out. Must be a positive integer.
retry_count: type: integer
description: The number of times a failed service call will be retried before giving up. Must be a non-negative integer.
default: 3
endpoint: type: string
description: The URL endpoint through which the service can be accessed.
auth_required: type: boolean
description: Indicates whether the service requires authentication.
default: yes
name: ApplicationSettingsApi.get_service_configs
description: Retrieve all service configurations for the application, including database settings, external service integration details, and feature flags.
parameters: type: dict
properties: environment: type: string
description: The deployment environment for which the service configurations are requested, such as 'development', 'staging', or 'production'.
enum: development
staging
production
default: production
include_sensitive: type: boolean
description: A flag to determine whether sensitive information like passwords and API keys should be included in the configurations.
default: no
name: ApplicationSettingsApi.order_service_config
description: Configure the order of services for an application according to specified preferences.
parameters: type: dict
required: service_order
properties: service_order: type: array
items: type: string
description: An ordered list of service identifiers that define the sequence in which services should be arranged.
user_id: type: integer
description: The unique identifier of the user for whom the service order is being configured.
preserve_existing: type: boolean
description: A flag indicating whether to preserve the existing service order if one exists. If set to 'false', the existing order will be overwritten.
default: yes
name: usage_api.UsageApi.get_hosts_per_day
description: Retrieve the number of hosts counted for a specified day, month, and year.
parameters: type: dict
required: day
month
year
properties: day: type: integer
description: The day of the month for which the host count is requested. Valid values are from 1 to 31, depending on the month.
month: type: integer
description: The month of the year for which the host count is requested. Valid values are from 1 (January) to 12 (December).
year: type: integer
description: The year for which the host count is requested. Should be a four-digit number, such as 2023.
name: get_monitoring_state
description: Retrieves the current monitoring state of a specified host, including the count of monitored hosts within the infrastructure.
parameters: type: dict
required: host_id
properties: host_id: type: string
description: The unique identifier of the host for which the monitoring state is being retrieved.
include_subdomains: type: boolean
description: Determines whether to include the count of monitored hosts from subdomains. When set to true, hosts from subdomains are included.
default: no
timeframe: type: string
description: The specific timeframe for which the monitoring data is requested, formatted as 'YYYY-MM-DD'.
default: null
name: usage_api.UsageApi.get_hosts_per_month
description: Retrieve the count of hosts for a given month and year. This information helps in understanding the usage pattern over time.
parameters: type: dict
required: month
year
properties: month: type: integer
description: The month for which the host count is queried. Represented as an integer from 1 (January) to 12 (December).
year: type: integer
description: The year for which the host count is queried. Represented as a four-digit integer such as 2021.
name: health_api.HealthApi.get_version
description: Retrieves the current API version information, including the major, minor, and patch version numbers.
parameters: type: dict
name: create_website_alert_config
description: Create a configuration for website alerting in the system, setting up conditions under which alerts are triggered.
parameters: type: dict
required: name
description
severity
websiteId
tagFilterExpression
granularity
rule
threshold
timeThreshold
properties: name: type: string
description: Name for the website alert configuration.
description: type: string
description: A brief description of the website alert configuration.
severity: type: integer
description: The severity level of the alert when triggered. Valid values are integers, typically ranging from 1 (lowest severity) to 10 (highest severity).
triggering: type: boolean
description: A flag to indicate if an incident is also triggered when the alert is triggered.
default: no
websiteId: type: string
description: The unique identifier of the website for which the alert is being configured.
tagFilterExpression: type: string
description: A boolean expression of tag filters that define the scope of relevant website beacons.
granularity: type: integer
description: The evaluation granularity in minutes used for the detection of threshold violations.
rule: type: string
description: The type of rule for this alert configuration, such as 'response_time' or 'error_rate'.
enum: response_time
error_rate
threshold: type: float
description: The threshold value that, when exceeded, will trigger the alert.
timeThreshold: type: integer
description: The time in minutes for which the threshold must be exceeded in order to trigger the alert.
alertChannelIds: type: array
items: type: string
description: A list of the IDs for alert channels where the alert notifications will be sent.
name: groups_api.GroupsApi.create_group_mapping
description: Creates a mapping between a group from an Identity Provider (IdP) such as LDAP, OIDC, or SAML, and an Instana group. Upon user login, if the IdP is configured and mappings are enabled, the provided key-value pairs from the IdP will be evaluated. If the key-value pairs match the mapping criteria, the user will be automatically assigned to the corresponding Instana group. Note that the 'id' field in the payload is ignored, as Instana will generate a new unique identifier for each mapping.
parameters: type: dict
required: group_id
key
value
properties: group_id: type: string
description: The unique identifier of the Instana group to which the mapping will be applied.
key: type: string
description: The attribute key received from the IdP to be used for mapping.
value: type: string
description: The expected value for the specified key that will trigger the mapping to the Instana group.
mapping_enabled: type: boolean
description: A flag indicating if the mapping should be enabled immediately upon creation.
default: yes
name: get_maintenance_configs
description: Retrieve a list of all maintenance configurations to manage system upkeep.
parameters: type: dict
required: api_version
properties: api_version: type: string
description: The API version used for the request, formatted as 'v[number]', such as 'v1'.
page: type: integer
description: The page number of the maintenance configurations list to fetch.
default: 1
size: type: integer
description: The number of maintenance configurations per page.
default: 10
active_only: type: boolean
description: A flag to retrieve only active maintenance configurations.
default: no
name: get_maintenance_configs_v2
description: Retrieve a list of all available maintenance configurations from the system.
parameters: type: dict
required: page
limit
properties: page: type: integer
description: The page number for pagination. Starts from 1.
limit: type: integer
description: The number of records to return per page. Maximum of 100.
sort_order: type: string
description: The order in which maintenance configurations should be sorted.
enum: asc
desc
default: asc
filter_by_status: type: string
description: Filter configurations by their status, such as 'active' or 'inactive'.
enum: active
inactive
default: active
name: MaintenanceConfigurationApi.get_maintenance_config
description: Retrieve the maintenance configuration settings for a specific system identified by its ID.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the system for which maintenance configuration is being retrieved.
name: api_token_api.APITokenApi.get_api_tokens
description: Retrieves a list of API tokens associated with the user's account.
parameters: type: dict
required: user_id
properties: user_id: type: string
description: The unique identifier for the user whose API tokens are being retrieved.
include_expired: type: boolean
description: Flag to determine if expired tokens should be included in the response.
default: no
name: CustomDashboardsApi.get_shareable_api_tokens
description: Retrieves a list of shareable API tokens associated with the custom dashboards.
parameters: type: dict
properties: user_id: type: string
description: The unique identifier of the user whose API tokens are to be retrieved.
include_expired: type: boolean
description: Determines whether to include expired tokens in the response.
default: no
required: user_id
name: api_token_api.APITokenApi.post_api_token
description: Create a new API token for authenticating against the API endpoints. The token ensures secure access to the provided services.
parameters: type: dict
required: user_id
permissions
properties: user_id: type: integer
description: The unique identifier of the user for whom the API token is being created.
permissions: type: string
description: The level of access granted by the token.
enum: read
write
admin
expiration_date: type: string
description: The expiration date of the token in the format 'YYYY-MM-DD'. If not provided, the token will expire in 1 year by default.
default: 2024-01-01
enabled: type: boolean
description: Flag indicating whether the token is enabled upon creation.
default: yes
name: audit_log_api.AuditLogApi.get_access_logs
description: Retrieve a list of access logs from the audit log API, with options to specify offset, query filters, and page size for pagination.
parameters: type: dict
required: offset
pageSize
properties: offset: type: integer
description: The starting index from which to return the list of access logs. An offset of 0 starts from the beginning.
query: type: string
description: A search query to filter the access logs based on specific criteria. For example, 'error' to find logs related to errors.
pageSize: type: integer
description: The number of access log entries to return in a single response for pagination purposes.
name: audit_log_api.AuditLogApi.get_audit_logs
description: Retrieve a list of audit logs based on specified criteria such as offset and query filters.
parameters: type: dict
required: offset
pageSize
properties: offset: type: integer
description: The starting index from which to return audit logs. Zero-based.
query: type: string
description: An optional search query to filter audit logs based on specific conditions, such as user actions or date range. Format: 'field:value'. Example: 'action:login'.
pageSize: type: integer
description: The number of audit logs to retrieve in a single request. Must be a positive integer.
name: ApplicationAnalyzeApi.get_trace_download
description: Retrieves detailed information about a trace with a specified ID, allowing for optional pagination.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier for the trace.
retrievalSize: type: integer
description: The number of trace entries to retrieve in one call. Defaults to 100 if not specified.
default: 100
offset: type: integer
description: The offset from the start of the trace data used for paginating results. Defaults to 0 to start from the beginning.
default: 0
ingestionTime: type: string
description: The timestamp representing when the trace was ingested. Format should be in UTC ISO 8601, such as '2023-01-15T00:00:00Z'. If not specified, defaults to the current time.
name: host_agent_api.HostAgentApi.get_agent_snapshot
description: Retrieves a snapshot of details for a specific host agent within a given time frame.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the host agent.
to: type: string
description: The end time for the snapshot data retrieval, in ISO 8601 format (e.g., '2023-01-01T00:00:00Z').
windowSize: type: integer
description: The size of the time window for the snapshot in minutes.
default: 60
name: host_agent_api.HostAgentApi.search_host_agents
description: Query the host agent snapshots based on the provided parameters to retrieve relevant data.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for filtering host agent snapshots, such as 'status:active'.
to: type: string
description: The end date for the query in the format 'YYYY-MM-DD'. If not specified, defaults to the current date.
windowSize: type: integer
description: The size of the time window in hours for the query.
default: 24
size: type: integer
description: The maximum number of host agent snapshots to return.
default: 100
offline: type: boolean
description: A flag indicating whether to include offline host agents in the results.
default: no
name: get_agent_support_information
description: Retrieve support information for a specific agent on a host, identified by host and support information IDs.
parameters: type: dict
required: hostId
supportInfoId
properties: hostId: type: string
description: Unique identifier for the host where the agent is running.
supportInfoId: type: string
description: Unique identifier for the support information related to the agent.
name: get_monitoring_state
description: Returns the count of hosts currently being monitored by the infrastructure resources API.
parameters: type: dict
required: api_key
properties: api_key: type: string
description: The API key used to authenticate requests to the infrastructure resources API.
environment: type: string
description: Specifies the environment for which the host monitoring count is required, such as 'production' or 'development'.
enum: production
development
staging
test
default: production
include_inactive: type: boolean
description: Determines whether to include inactive hosts in the count.
default: no
name: InfrastructureCatalogApi.get_infrastructure_catalog_plugins
description: Retrieve a list of all available plugin identifiers that can be used to monitor the system.
parameters: type: dict
name: get_website_catalog_metrics
description: Retrieve a list of all available metric definitions used for website monitoring.
parameters: type: dict
properties: category: type: string
description: The category of metrics to retrieve, such as 'performance' or 'availability'.
enum: performance
availability
functionality
security
default: performance
include_deprecated: type: boolean
description: A flag to determine if deprecated metrics should be included in the results.
default: no
name: software_versions
description: Retrieve information about the installed software, including runtime and package manager details. Use optional filters to refine the results.
parameters: type: dict
properties: time: type: string
description: The time at which the software details were retrieved, in the format 'YYYY-MM-DD HH:MM:SS'.
default: null
origin: type: string
description: The source or repository from which the software was installed.
type: type: string
description: The type of the software, such as 'runtime' or 'package_manager'.
enum: runtime
package_manager
name: type: string
description: The name of the software to filter by.
version: type: string
description: The version of the software to filter by.
name: health_api.HealthApi.get_version
description: Retrieve the current version information of the API.
parameters: type: dict
name: ApplicationSettingsApi.get_application_configs
description: Retrieve all configuration settings for the application, including environment variables, feature toggles, and system behaviors.
parameters: type: dict
required: environment
properties: environment: type: string
description: The deployment environment for which the application configurations are being retrieved, such as 'development', 'staging', or 'production'.
enum: development
staging
production
include_sensitive: type: boolean
description: A flag indicating whether to include sensitive configurations like API keys and passwords. It is recommended to keep this false unless necessary.
default: no
config_type: type: string
description: The type of configurations to retrieve, such as 'feature_toggles' or 'system_behaviors'.
enum: all
feature_toggles
system_behaviors
default: all
name: ApplicationAnalyzeApi.get_trace_download
description: Retrieves detailed information about a specific trace from an application analysis system by trace ID. The response includes trace data up to a specified retrieval size, starting from a given offset. The data can be filtered based on the time of ingestion.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the trace to retrieve.
retrievalSize: type: integer
description: The maximum number of trace entries to retrieve.
default: 100
offset: type: integer
description: The offset from which to start retrieving trace entries.
default: 0
ingestionTime: type: string
description: The ingestion time to filter the trace data, formatted as an ISO 8601 timestamp, such as '2023-03-25T13:00:00Z'.
name: ApplicationAnalyzeApi.get_call_details
description: Retrieve the details of a specific call using its trace ID and call ID.
parameters: type: dict
required: traceId
callId
properties: traceId: type: string
description: The unique identifier for the trace of the call.
callId: type: string
description: The unique identifier for the individual call within a trace.
name: ApplicationAnalyzeApi.get_correlated_traces
description: Retrieve backend trace IDs corresponding to the provided correlation IDs from website and mobile app monitoring data.
parameters: type: dict
required: correlationId
properties: correlationId: type: string
description: The unique identifier used for correlating traces between backend and monitoring systems, typically a UUID.
name: get_website_geo_mapping_rules
description: Retrieve custom geographical mapping rules that are configured for a specific website based on its unique identifier.
parameters: type: dict
required: websiteId
properties: websiteId: type: string
description: A unique identifier for the website for which geo mapping rules are being retrieved. This should be a valid UUID.
name: set_website_geo_mapping_rules
description: Set custom geographic mapping rules for a website, enabling different content or behaviors based on user location.
parameters: type: dict
required: websiteId
geoMappingRules
properties: websiteId: type: string
description: The unique identifier for the website.
geoMappingRules: type: array
items: type: dict
description: An array of mapping rules that define how the website behaves for users from different geographic locations.
name: website_configuration_api.get_website_geo_location_configuration
description: Retrieve the geographical location configuration settings associated with a specific website, identified by its unique website ID.
parameters: type: dict
required: websiteId
properties: websiteId: type: string
description: The unique identifier of the website for which the geo location configuration is being retrieved. This is typically a UUID.
name: CustomDashboardsApi.add_custom_dashboard
description: This function creates a new custom dashboard with a specified configuration and adds it to the system.
parameters: type: dict
required: dashboard_name
widgets
layout
properties: dashboard_name: type: string
description: The name of the custom dashboard to be created.
widgets: type: array
items: type: string
description: A list of widget identifiers to be included in the dashboard.
layout: type: string
description: The layout configuration for the dashboard.
enum: grid
freeform
single
description: type: string
description: A brief description of the dashboard's purpose and contents.
default: No description provided.
is_public: type: boolean
description: A flag indicating whether the dashboard should be public or private.
default: no
name: CustomDashboardsApi.get_custom_dashboards
description: Retrieves a list of custom dashboards that the user has access to, based on the provided query parameters.
parameters: type: dict
required: query
properties: query: type: string
description: A search query string to filter accessible dashboards. Supports logical operators and field-specific filtering.
pageSize: type: integer
description: The number of dashboard entries to return per page.
default: 10
page: type: integer
description: The page number to retrieve, used for paginating through large sets of dashboard entries.
default: 1
name: CustomDashboardsApi.get_custom_dashboard
description: Retrieve the details of a custom dashboard by its unique identifier.
parameters: type: dict
required: customDashboardId
properties: customDashboardId: type: string
description: The unique identifier of the custom dashboard to retrieve.
name: get_synthetic_credential_names
description: Retrieve a list of all synthetic credential names used for synthetic monitoring.
parameters: type: dict
properties: filter: type: string
description: A filter to apply to the credential names list, such as 'active' or 'inactive'.
enum: active
inactive
default: active
sort_order: type: string
description: The order in which to sort the credential names, either 'asc' for ascending or 'desc' for descending.
enum: asc
desc
default: asc
name: delete_synthetic_credential
description: Deletes a specific synthetic credential from the system by its unique name.
parameters: type: dict
required: name
properties: name: type: string
description: The unique name identifier of the synthetic credential to be deleted.
name: create_synthetic_credential
description: Creates a credential to be used in Synthetic API Script Tests. The credential consists of a name and an associated encrypted value. Once created, the credential's value cannot be retrieved.
parameters: type: dict
required: credentialName
credentialValue
properties: credentialName: type: string
description: The unique identifier for the credential. It must start with a letter and can contain only letters, numbers, and underscores. The maximum length is 64 characters.
credentialValue: type: string
description: The value of the credential to be used during API Script execution. This value is stored in an encrypted form and cannot be retrieved after creation.
name: SyntheticSettingsApi.get_synthetic_location
description: Retrieves the details of a synthetic monitoring location based on the specified identifier.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier for the synthetic monitoring location.
name: get_synthetic_locations
description: Retrieves a list of all available synthetic locations for monitoring. The function supports sorting, pagination, and filtering options to organize and select the desired subset of locations.
parameters: type: dict
required: sort
offset
limit
properties: sort: type: string
description: Specifies the field to sort by. Options include 'name' for location name, 'id' for unique identifier, 'created_at' for creation date, or 'updated_at' for the last update date.
enum: name
id
created_at
updated_at
offset: type: integer
description: The starting point for the list of locations, used for pagination. Represents the number of records to skip before starting to collect the result set.
limit: type: integer
description: The maximum number of locations to return in a single response. Used for pagination.
filter: type: string
description: A search filter to apply to the list of locations. Defaults to 'status:active' which retrieves only active locations.
default: status:active
name: get_location_summary_list
description: Retrieves a summary list of synthetic monitoring locations, including the most recent test run data for each location.
parameters: type: dict
properties: include_inactive: type: boolean
description: Determines whether to include inactive locations in the list. By default, only active locations are included.
default: no
filter: type: string
description: A query string to filter locations based on specific criteria such as location name or identifier.
limit: type: integer
description: The maximum number of locations to return. Defaults to 100, which is the maximum.
default: 100
name: get_synthetic_locations
description: Retrieves a list of all synthetic locations available for monitoring. The list can be sorted, filtered, and paginated using the provided parameters.
parameters: type: dict
required: sort
properties: sort: type: string
description: Determines the order of the returned locations list. Use 'asc' for ascending or 'desc' for descending order.
enum: asc
desc
offset: type: integer
description: The starting point from where to return the locations, useful for pagination. Zero-based index.
default: 0
limit: type: integer
description: Limits the number of locations to be returned. Must be a positive integer.
default: 50
filter: type: string
description: A query string to filter the locations based on specific criteria, such as location name or status.
name: SyntheticSettingsApi.get_synthetic_location
description: Retrieve details of a specific synthetic location by its identifier.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the synthetic location.
name: get_location_summary_list
description: Retrieves a list of synthetic monitoring locations along with the latest test results for each location.
parameters: type: dict
required: api_key
properties: api_key: type: string
description: The API key used to authenticate the request.
include_inactive: type: boolean
description: Flag to include inactive locations in the list.
default: no
filter: type: string
description: A query string to filter locations based on certain criteria, such as region or status.
limit: type: integer
description: The maximum number of locations to return in the response.
default: 100
name: update_identity_provider
description: Updates the identity provider settings to allow or restrict users based on whether they belong to an IdP group with empty mappings. For further details, refer to the documentation on checking user restrictions for empty IdP group mappings.
parameters: type: dict
required: RestrictEmptyIdpGroups
properties: RestrictEmptyIdpGroups: type: boolean
description: A flag to set whether users with empty IdP group mappings are allowed or restricted. When true, such users are restricted; when false, they are allowed.
name: get_identity_provider_patch
description: Checks if the system denies access for users with empty Identity Provider (Idp) group mappings. If 'RestrictEmptyIdpGroups' is true, the system is in a locked state, only permitting access to users with at least one active mapping rule applied during login.
parameters: type: dict
required: tenant_id
properties: tenant_id: type: string
description: The unique identifier of the tenant for which the restriction on empty Idp group mapping is checked.
include_rules: type: boolean
description: Determines whether to include the mapping rules applied to the user in the response. Defaults to false.
default: no
name: groups_api.GroupsApi.create_group_mapping
description: Creates a mapping between an external Identity Provider group (such as LDAP, OIDC, SAML) and an Instana group. When mappings are enabled, user attributes received from the Identity Provider during login are evaluated against these mappings. If a user's attributes match a specific mapping, the user is then assigned to the corresponding Instana group. Note that the 'id' field provided in the payload is disregarded; Instana instead generates a unique identifier for each new mapping.
parameters: type: dict
required: group_mapping_payload
properties: group_mapping_payload: type: dict
description: The payload containing the mapping details between the IdP group and the Instana group. The 'id' field within this payload will be ignored.
properties: groupId: type: string
description: The unique identifier for the Instana group to which users will be mapped.
mappingAttributes: type: array
items: type: string
description: A list of user attributes sent by the IdP that are used to evaluate the mapping. Each attribute is represented as a string.
mappingValues: type: array
items: type: string
description: A list of values corresponding to the mappingAttributes that must be matched for the mapping to be successful.
name: audit_log_api.AuditLogApi.get_access_logs
description: Retrieve a list of access log entries from the audit log. This can be used to monitor access patterns or identify potential security breaches.
parameters: type: dict
required: offset
pageSize
properties: offset: type: integer
description: The starting point from which to return results. Useful for implementing pagination.
query: type: string
description: A search query to filter the access logs based on specific criteria. For example, user names or IP addresses.
pageSize: type: integer
description: The number of access log entries to be returned in a single call. Determines the size of the result set for pagination.
name: audit_log_api.AuditLogApi.get_audit_logs
description: Retrieve a list of audit log entries from the system. Allows for pagination and filtering using query parameters.
parameters: type: dict
required: pageSize
properties: offset: type: integer
description: The starting index from which to return the results. Used for pagination.
default: 0
query: type: string
description: A query string to filter the audit logs based on specific conditions, such as date range or event type.
pageSize: type: integer
description: The number of audit log entries to return in a single response. Determines the page size for pagination.
name: CustomDashboardsApi.get_shareable_api_tokens
description: Retrieve a list of shareable API tokens associated with the user's account. This can be used to grant third-party services access to the user's dashboard data without exposing personal credentials.
parameters: type: dict
name: create_global_application_alert_config
description: Create a new global application alert configuration setting for monitoring and notifications.
parameters: type: dict
required: name
alert_type
threshold
recipients
properties: name: type: string
description: A unique name identifying the alert configuration.
alert_type: type: string
description: The type of alert to be configured.
enum: error_rate
response_time
traffic_spike
threshold: type: float
description: The value at which the alert should be triggered. Units depend on the alert_type.
recipients: type: array
items: type: string
description: A list of email addresses to notify when the alert is triggered.
enabled: type: boolean
description: Flag indicating whether the alert configuration is enabled or not.
default: yes
name: enable_global_application_alert_config
description: Activate the global alert configuration for an application using the specified identifier.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the application alert configuration to be enabled.
name: create_mobile_app_alert_config
description: Creates a configuration for mobile app alerts, specifying the conditions and recipients for notifications.
parameters: type: dict
required: app_id
alert_name
threshold
recipients
properties: app_id: type: string
description: The unique identifier of the mobile application.
alert_name: type: string
description: A descriptive name for the alert.
threshold: type: integer
description: The numerical value at which the alert should be triggered.
recipients: type: array
items: type: string
description: A list of email addresses that will receive the alert.
severity: type: string
description: The severity level of the alert.
enum: low
medium
high
default: low
enabled: type: boolean
description: A flag indicating whether the alert configuration is active.
default: yes
name: EventSettingsApi.get_custom_event_specification
description: Retrieve the details of a custom event specification using its unique identifier.
parameters: type: dict
required: eventSpecificationId
properties: eventSpecificationId: type: string
description: The unique identifier of the custom event specification.
name: events_api.EventsApi.get_event
description: Retrieve details of a specific event using its unique identifier (ID).
parameters: type: dict
required: eventId
properties: eventId: type: string
description: The unique identifier of the event to be retrieved.
name: EventSettingsApi.get_alerting_channel
description: Retrieve the configuration details of a specific alerting channel by its identifier.
parameters: type: dict
required: id
properties: id: type: string
description: The unique identifier of the alerting channel.
name: website_configuration_api.get_websites
description: Retrieves a list of website configurations currently set in the system.
parameters: type: dict
required: api_key
properties: api_key: type: string
description: The API key used to authenticate the request.
status_filter: type: string
description: Filter the list of websites by their status.
enum: active
inactive
pending
default: active
include_details: type: boolean
description: Determines if detailed information for each website should be included in the response.
default: no
name: ApplicationSettingsApi.get_service_configs
description: Retrieve the configuration settings for all services managed by the application.
parameters: type: dict
properties: service_name: type: string
description: The name of the service to filter the configurations. If omitted, configurations for all services are returned.
default: all
include_sensitive: type: boolean
description: Flag to determine if sensitive information such as passwords or tokens should be included in the configurations.
default: no
name: ApplicationSettingsApi.get_application_configs
description: Retrieve all configuration settings for the application. This includes settings such as feature toggles, system behaviors, and user preferences.
parameters: type: dict
properties: environment: type: string
description: The application environment for which the configurations are to be fetched, e.g., 'production', 'staging', or 'development'.
enum: production
staging
development
default: production
include_sensitive: type: boolean
description: Flag to determine if sensitive configurations such as API keys and passwords should be included in the response.
default: no