Tideway

https://traversys.github.io/Tideway
Admin
Tideway is a simplified Python library for the BMC Discovery API that provides seamless access to...
Tokens:19,152
Snippets:164
Trust Score:8.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Appliance Information

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Retrieves general information about the BMC Discovery appliance, such as its version and the versions of installed packages. Returns plain text containing version details.

```python
>>> details = tw.get_admin_about.text
>>> print(details)
```

--------------------------------

### Install Tideway Python Package (Shell)

Source: https://traversys.github.io/Tideway

Provides the command to install the Tideway Python library using pip. This is the standard method for installing Python packages from the Python Package Index (PyPI).

```bash
python -m pip install tideway
```

--------------------------------

### Start or Stop Discovery Process

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Starts or stops the discovery process by sending a JSON payload. The payload must include a 'status' key with either 'running' or 'stopped'. Returns a boolean indicating success.

```python
discovery.patch_discovery({"status": "running"}).ok
```

--------------------------------

### Get API Provider Metadata

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Fetches metadata for API providers supported by BMC Discovery. The output is a JSON list, and this example shows how to access credential parameters for the first provider.

```python
discovery.get_discovery_api_provider_metadata.json()[0]['cred_params'][0]
```

--------------------------------

### Get Cloud Provider Metadata

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves metadata for cloud providers supported by BMC Discovery. This example demonstrates accessing the mandatory credential parameters for the Azure provider.

```python
discovery.get_discovery_api_cloud_metadata.json()[0]['cred_params'][0]
```

--------------------------------

### Initialize Tideway Appliance and Get About Info

Source: https://traversys.github.io/Tideway/quickstart/responses.html

Initializes a Tideway appliance object with hostname and authentication token, then fetches general information about the appliance. This is the foundational step for interacting with the API.

```python
>>> tw = tideway.appliance('appliance-hostname','auth-token',api_version='1.2')
>>> response = tw.about()
```

--------------------------------

### GET /discovery

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves the current status of the discovery process.

```APIDOC
## GET /discovery

### Description
Returns the current running status of the discovery process.

### Method
GET

### Endpoint
/discovery

### Response
#### Success Response (200)
- **running** (boolean) - Indicates if discovery is active
- **status** (string) - Current status string

#### Response Example
{
  "running": false,
  "status": "running"
}
```

--------------------------------

### POST post_topology_nodes

Source: https://traversys.github.io/Tideway/endpoints/topology.html

Retrieves topology data starting from one or more specified nodes.

```APIDOC
## POST post_topology_nodes

### Description
Get topology data from one or more starting nodes.

### Method
POST

### Request Body
- **json** (JSON Object) - Required - The starting node configuration.

### Response
#### Success Response (200)
- **data** (Object) - The topology data for the requested nodes.
```

--------------------------------

### Run GET Request to Endpoint

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Executes a direct endpoint query using an HTTP GET request. Requires the specific endpoint path as a string parameter. Returns the response from the endpoint.

```python
>>> tw.get("/vault")
{
    "open": true,
    "passphrase_saved": false,
    "passphrase_set": false
}
```

--------------------------------

### Get Admin About Information (Python)

Source: https://traversys.github.io/Tideway/endpoints/admin.html

Fetches the versions of the API supported by a BMC Discovery version. The result is returned as a JSON object containing API versions, component, product, and version details.

```python
tw.get_admin_about.json()
```

--------------------------------

### GET /api/about

Source: https://traversys.github.io/Tideway/quickstart/responses.html

Retrieves information about the BMC Discovery appliance, including supported API versions and product version details.

```APIDOC
## GET /api/about

### Description
Returns metadata about the BMC Discovery appliance, including the product version, component name, and a list of supported API versions.

### Method
GET

### Endpoint
/api/about

### Parameters
None

### Request Example
```
tw.about()
```

### Response
#### Success Response (200)
- **api_versions** (array) - List of supported API versions
- **component** (string) - The name of the component (e.g., "REST API")
- **product** (string) - The product name (e.g., "BMC Discovery")
- **version** (string) - The current product version

#### Response Example
{
    "api_versions": ["1.0", "1.1", "1.2"],
    "component": "REST API",
    "product": "BMC Discovery",
    "version": "12.2"
}
```

--------------------------------

### GET /discovery/runs/schedules

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves a list of all or specific scan schedules.

```APIDOC
## GET /discovery/runs/schedules

### Description
Get a list of all or specific scan schedules.

### Method
GET

### Endpoint
`/discovery/runs/schedules`

### Parameters
#### Query Parameters
- **run_id** (String) - Optional - The ID of the discovery run to get the schedule for.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **schedule_id** (String) - The ID of the scan schedule.
- **run_id** (String) - The ID of the discovery run associated with the schedule.
- **schedule** (String) - The schedule details.

#### Response Example
```json
[
  {
    "schedule_id": "schedule-123",
    "run_id": "run-abc",
    "schedule": "daily at 02:00"
  }
]
```
```

--------------------------------

### GET /get_knowledge

Source: https://traversys.github.io/Tideway/endpoints/knowledge.html

Retrieves the current state of the appliance's knowledge, including details on TKU versions.

```APIDOC
## GET /get_knowledge

### Description
Retrieves the current state of the appliance's knowledge, including TKU versions.

### Method
GET

### Endpoint
/get_knowledge

### Response
#### Success Response (200)
- **latest_tku** (object) - Information regarding the latest Technology Knowledge Update.

#### Response Example
{
	"latest_tku": {
		"submission_date": "2021-05-24T23:06:00.350840+00:00"
	}
}
```

--------------------------------

### Get Licensing Report

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Fetches the latest signed licensing report in plain text format. This report provides details on the appliance's licensing status.

```python
>>> tw.get_admin_licensing.text
-----BEGIN LICENSE REPORT-----
License report
==============

Report start time: 2021-01-18 23:00:00.409987+00:00
Report end time  : 2021-01-21 23:00:00.410085+00:00
...
```

--------------------------------

### GET /models

Source: https://traversys.github.io/Tideway/endpoints/models.html

Retrieve service and application models based on various filter criteria.

```APIDOC
## GET /models

### Description
Retrieve service and application models. Can be filtered by name, type, kind, and other attributes.

### Method
GET

### Endpoint
.get_model()

### Parameters
#### Query Parameters
- **name** (String) - Optional - Model name
- **type** (String) - Optional - Model type (rules_template, rules, sam, static, instance, imported)
- **kind** (String) - Optional - Model kind (BusinessService, TechnicalService, BusinessApplicationInstance)
- **published** (Boolean) - Optional - Filter by published status
- **review_suggested** (Boolean) - Optional - Filter by review status
- **delete** (Boolean) - Optional - Default: False - Flag to delete after retrieval

### Response
#### Success Response (200)
- **models** (Array) - List of model objects
```

--------------------------------

### PATCH /discovery

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Starts or stops the discovery process by updating the status.

```APIDOC
## PATCH /discovery

### Description
Updates the discovery process state (e.g., start or stop).

### Method
PATCH

### Endpoint
/discovery

### Request Body
- **status** (string) - Required - The desired state (e.g., "running", "stopped")

### Request Example
{
  "status": "running"
}

### Response
#### Success Response (200)
- **ok** (boolean) - Returns true if the operation was successful
```

--------------------------------

### Get Request URL

Source: https://traversys.github.io/Tideway/quickstart/responses.html

Retrieves the URL that was requested to get this response. This is useful for verifying the endpoint that was hit.

```python
>>> tw.about().url
https://appliance-hostname/api/about
```

--------------------------------

### GET /discovery/runs/{run_id}/inferred

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves a summary of inferred devices from a discovery run, partitioned by device type.

```APIDOC
## GET /discovery/runs/{run_id}/inferred

### Description
Get a summary of all inferred devices from a discovery run, partitioned by device type and/or which have a specific inferred kind.

### Method
GET

### Endpoint
`/discovery/runs/{run_id}/inferred`

### Parameters
#### Path Parameters
- **run_id** (String) - Required - The ID of the discovery run.

#### Query Parameters
- **inferred_kind** (String) - Optional - Filters inferred devices by kind.
- **offset** (Integer) - Optional - The offset for pagination.
- **results_id** (String) - Optional - The ID for specific results.
- **format** (String) - Optional - The output format. Options: "object".
- **limit** (Integer) - Optional - The maximum number of results to return. Default: 100.
- **delete** (Boolean) - Optional - Whether to delete results after retrieval. Options: True, False. Default: False

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **count** (Integer) - The number of inferred devices of this kind.
- **kind** (String) - The type of inferred device.
- **offset** (Integer) - The offset for pagination.
- **results** (Array) - A list of inferred devices.

#### Response Example
```json
[
	{
		'count': 4,
		'kind': 'Host',
		'offset': 0,
		'results': [
			{
				'#InferredElement:Inference:Associate:DiscoveryAccess.endpoint': [
					'192.168.1.1',
					'192.168.1.2',
					'192.168.1.3',
					'192.168.1.10'
				],
				'#id': 'A1B2C3D4E5F6'
...
```
```

--------------------------------

### GET /get_knowledge_status

Source: https://traversys.github.io/Tideway/endpoints/knowledge.html

Retrieves the current status of a knowledge upload process.

```APIDOC
## GET /get_knowledge_status

### Description
Get the current state of a knowledge upload, including processing status and messages.

### Method
GET

### Endpoint
/get_knowledge_status

### Response
#### Success Response (200)
- **error** (string) - Error message if any.
- **last_result** (string) - The result of the last operation.
- **messages** (array) - List of status messages.
- **processing** (boolean) - Whether the upload is currently processing.
- **uploading** (boolean) - Whether the upload is currently in progress.

#### Response Example
{
	"error": "",
	"last_result": "success",
	"messages": ["Validate upload: Completed OK"],
	"processing": false,
	"uploading": false
}
```

--------------------------------

### Query Topology Node Kinds

Source: https://traversys.github.io/Tideway/endpoints/topology.html

Retrieves nodes of specific kinds that are related to a provided set of starting nodes.

```python
.post_topology_nodes_kinds(json_data)
```

--------------------------------

### GET /data/kinds/{kind}

Source: https://traversys.github.io/Tideway/endpoints/data.html

Finds all nodes of a specified node kind. Supports pagination and filtering.

```APIDOC
## GET /data/kinds/{kind}

### Description
Finds all nodes of a specified node kind. This endpoint is useful for discovering all instances of a particular type of node within the system.

### Method
GET

### Endpoint
/data/kinds/{kind}

### Parameters
#### Path Parameters
- **kind** (String) - Required - The node kind to search for (e.g., "SoftwareInstance").

#### Query Parameters
- **offset** (Integer) - Optional - The starting offset for results.
- **results_id** (String) - Optional - An identifier for a previous search result set.
- **format** (String) - Optional - Defaults to "object". The desired format for the results.
- **limit** (Integer) - Optional - Defaults to 100. The maximum number of results to return.
- **delete** (Boolean) - Optional - Defaults to False. If True, marks nodes for deletion.

### Request Example
```json
{
  "example": "request example for get_data_kinds"
}
```

### Response
#### Success Response (200)
- **results** (Array) - A list of nodes matching the specified kind, potentially with details like ID, name, and version.

#### Response Example
```json
{
  "example": "['0x7761771a5876f667606e53426', 'Apache Webserver', 'Apache Webserver 2.4 on batman3', '2.4', 'batman3']"
}
```
```

--------------------------------

### Get Admin Baseline Status (Python)

Source: https://traversys.github.io/Tideway/endpoints/admin.html

Retrieves a summary of the appliance status, including details of which baseline checks have passed or failed. The output can be accessed in JSON format.

```python
tw.get_admin_baseline.json()['results']['FAILED'][0]
```

--------------------------------

### Get Licensing Data (Raw Encrypted)

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Fetches the latest license data as an encrypted raw license object. This is intended for importing license data to another appliance.

```python
>>> tw.get_admin_licensing_raw
```

--------------------------------

### GET /models/{key}/topology

Source: https://traversys.github.io/Tideway/endpoints/models.html

Retrieve the topology structure for a specific model identified by its key.

```APIDOC
## GET /models/{key}/topology

### Description
Get topology for the model definition specified by key.

### Method
GET

### Endpoint
.get_model_topology(__key__ [, attributes ])

### Parameters
#### Path Parameters
- **key** (String) - Required - The unique model key

#### Query Parameters
- **attributes** (String) - Optional - CSV list of attributes to return

### Response
#### Success Response (200)
- **topology** (Object) - The topology definition
```

--------------------------------

### GET get_data_nodes_graph

Source: https://traversys.github.io/Tideway/endpoints/topology.html

Retrieves a graph of nodes and relationships associated with a specific node.

```APIDOC
## GET get_data_nodes_graph

### Description
Graph data represents a set of nodes and relationships that are associated to the given node.

### Method
GET

### Parameters
#### Query Parameters
- **node_id** (JSON Object) - Required - The ID of the node to query.
- **focus** (String) - Optional - Filter by "software-connected", "software", or "infrastructure".
- **apply_rules** (Boolean) - Optional - Whether to apply rules (Default: False).

### Response
#### Success Response (200)
- **graph** (Object) - The resulting node and relationship graph.
```

--------------------------------

### GET /discovery/runs/{run_id}/results

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves a summary of discovery run results partitioned by result type.

```APIDOC
## GET /discovery/runs/{run_id}/results

### Description
Get a summary of the results from scanning all endpoints in the run, partitioned by result type that had a specific type of result.

### Method
GET

### Endpoint
`/discovery/runs/{run_id}/results`

### Parameters
#### Path Parameters
- **run_id** (String) - Required - The ID of the discovery run.

#### Query Parameters
- **result** (String) - Optional - Filters results by type. Options: "Success", "Skipped", "NoAccess", "NoResponse", "Error", "Dropped". Default: "Success"
- **offset** (Integer) - Optional - The offset for pagination.
- **results_id** (String) - Optional - The ID for specific results.
- **format** (String) - Optional - The output format. Options: "object".
- **limit** (Integer) - Optional - The maximum number of results to return. Default: 100.
- **delete** (Boolean) - Optional - Whether to delete results after retrieval. Options: True, False. Default: False

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **count** (Integer) - The number of results of this type.
- **uri** (String) - The URI to retrieve detailed results for this type.

#### Response Example
```json
{
    "Dropped": {
        "count": 204,
        "uri": "https://appliance/api/v1.2/discovery/runs/1234567890/results/Dropped"
    },
    "Skipped": {
        "count": 3,
        "uri": "https://appliance/api/v1.2/discovery/runs/1234567890/results/Skipped"
    },
    "Success": {
        "count": 47,
        "uri": "https://appliance/api/v1.2/discovery/runs/1234567890/results/Success"
    }
}
```
```

--------------------------------

### GET /discovery/runs/{run_id}

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves details for a specific discovery run or all active runs.

```APIDOC
## GET /discovery/runs/{run_id}

### Description
Fetches information about a specific discovery run using its unique identifier.

### Method
GET

### Endpoint
/discovery/runs/{run_id}

### Parameters
#### Path Parameters
- **run_id** (string) - Required - The UUID of the discovery run

### Response
#### Success Response (200)
- **label** (string) - Name of the run
- **scan_kind** (string) - Type of scan
- **uuid** (string) - Unique identifier

#### Response Example
{
  "label": "Network Snapshot",
  "scan_kind": "IP",
  "uuid": "1234567890"
}
```

--------------------------------

### GET /data/partitions

Source: https://traversys.github.io/Tideway/endpoints/data.html

Retrieves graph data representing a set of nodes and relationships associated with the given node. This endpoint lists available data partitions.

```APIDOC
## GET /data/partitions

### Description
Graph data represents a set of nodes and relationships that are associated to the given node. This endpoint returns a mapping of partition names to their corresponding IDs.

### Method
GET

### Endpoint
/data/partitions

### Parameters
None

### Request Example
```json
{
  "example": "request example for get_data_partitions"
}
```

### Response
#### Success Response (200)
- **partitions** (Object) - A dictionary where keys are partition names (e.g., "Audit", "Default") and values are their unique identifiers.

#### Response Example
```json
{
  "example": "{\"Audit\": \"fb30ac60bb23b90471917ae7\", \"Default\": \"fb30ac60bb23b90471917ae5\"}"
}
```
```

--------------------------------

### Query Topology Nodes

Source: https://traversys.github.io/Tideway/endpoints/topology.html

Retrieves topology data starting from one or more specified nodes using a JSON input object.

```python
.post_topology_nodes(json_data)
```

--------------------------------

### Get Discovery Run Inferred Devices

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Fetches a summary of inferred devices from a discovery run, categorized by device type or inferred kind. Parameters include run ID, inferred kind, offset, and limit. The output format can be set to 'object'.

```python
>>> result = discovery.get_discovery_run_inferred("1234567890", "Host", format="object")
>>> print(result.text)
[
	{
		'count': 4,
		'kind': 'Host',
		'offset': 0,
		'results': [
			{
				'#InferredElement:Inference:Associate:DiscoveryAccess.endpoint': [
					'192.168.1.1',
					'192.168.1.2',
					'192.168.1.3',
					'192.168.1.10'
				],
				'#id': 'A1B2C3D4E5F6'
...
	}
]
```

--------------------------------

### Get Licensing Data (CSV)

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Retrieves the latest raw license data in CSV format, packaged as a zip file for offline analysis. This endpoint is used for exporting license information.

```python
>>> tw.get_admin_licensing_csv
```

--------------------------------

### Get API Help - Tideway API

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Provides help information for specific Discovery API endpoints and functions. By default, it outputs a full list of available endpoints and their associated functions. An optional 'endpoint' parameter can filter the results.

```text
>>> tw.help()

```

```text
>>> tw.help("/vault/credentials/{cred_id}")
Endpoint                      Function                          Description
----------------------------  --------------------------------  ---------------------------------------------------------------------------------
/vault/credentials/{cred_id}  deleteCredential(cred_id)         Delete a credential.
/vault/credentials/{cred_id}  listCredentials(cred_id)          Get the properties of a specific credential.
/vault/credentials/{cred_id}  updateCredential(cred_id, body)   Updates partial resources of a credential. Missing properties are left unchanged.
/vault/credentials/{cred_id}  replaceCredential(cred_id, body)  Replaces a single credential. All required credential properties must be present.

```

--------------------------------

### Get Discovery Excludes

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves a list of all discovery excludes. This method can optionally filter by a specific exclude ID.

```python
discovery.get_discovery_exclude(_exclude_id_)
```

--------------------------------

### Get API Schema (Swagger) for BMC Discovery

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Fetches the JSON Swagger file which contains the API schema for BMC Discovery. This is useful for understanding the available API endpoints and their structures.

```python
>>> swagger = tw.api_swagger
>>> from pprint import pprint
>>> pprint(api_swagger.json()['tags'])
```

--------------------------------

### Get Model Topology by Key (Python)

Source: https://traversys.github.io/Tideway/endpoints/models.html

Retrieves the topology information for a model specified by its key. An optional comma-separated string of attributes can be provided to filter the topology data.

```python
model_key_for_topology = "model-key"
topology_data = tw.models().get_model_topology(model_key_for_topology)

# With specific attributes
topology_with_attributes = tw.models().get_model_topology(model_key_for_topology, attributes='name,ip_address')
```

--------------------------------

### Get Licensing Report (Python)

Source: https://traversys.github.io/Tideway/endpoints/admin.html

Retrieves the latest signed licensing report. Supports different content types: 'text/plain' for the default report, 'csv' for raw data in CSV format (downloaded as a zip file), and 'raw' for an encrypted license object.

```python
tw.licensing()
```

```python
tw.licensing('csv')
```

```python
tw.licensing('raw')
```

--------------------------------

### Get HTTP Reason Phrase

Source: https://traversys.github.io/Tideway/quickstart/responses.html

Retrieves the human-readable reason phrase associated with the HTTP status code (e.g., 'OK', 'Not Found').

```python
>>> tw.about().reason
OK
```

--------------------------------

### GET /data/nodes/{node_id}

Source: https://traversys.github.io/Tideway/endpoints/data.html

Retrieves the state of a specific node identified by its ID. Supports fetching related information and traversal.

```APIDOC
## GET /data/nodes/{node_id}

### Description
Get the state of a node with specified id. This endpoint allows fetching detailed information about a node, including its relationships and traversal paths.

### Method
GET

### Endpoint
/data/nodes/{node_id}

### Parameters
#### Path Parameters
- **node_id** (JSON Object) - Required - The unique identifier for the node.

#### Query Parameters
- **relationships** (Boolean) - Optional - Defaults to False. If True, includes related nodes.
- **traverse** (String) - Optional - Specifies the traversal path. Format: "NodeKind:Relationship:NodeKind:Node".
- **flags** (String) - Optional - Filters the results. Options: "include_destroyed", "exclude_current".

### Request Example
```json
{
  "example": "request example for get_data_nodes"
}
```

### Response
#### Success Response (200)
- **state** (Object) - Contains the state information of the node, including 'os_type'.
- **relationships** (Array) - List of related nodes if requested.

#### Response Example
```json
{
  "example": "{\"state\": {\"os_type\": \"Windows Desktop\"}}"
}
```
```

--------------------------------

### Get Response Text

Source: https://traversys.github.io/Tideway/quickstart/responses.html

Returns the response content as a string. This is suitable for text-based responses like HTML or plain text, after potential decoding.

```python
>>> tw.about().text
{
    "api_versions": [
        "1.0",
        "1.1",
        "1.2"
    ],
    "component": "REST API",
    "product": "BMC Discovery",
    "version": "12.2"
}
```

--------------------------------

### Get Appliance Baseline Status

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Retrieves a summary of the appliance status, including details on which baseline checks have passed or failed. Returns a JSON object with failure details if any.

```python
>>> tw.get_admin_baseline.json()['results']['FAILED'][0]
{'enabled': True, 'message': 'MAJOR: This appliance has insufficent resources', 'name': 'Appliance Specification', 'severity': 'MAJOR'}
```

--------------------------------

### Get Model Definition by Key (Python)

Source: https://traversys.github.io/Tideway/endpoints/models.html

Retrieves the definition of a specific model using its unique key. This function is useful for inspecting the details of an existing model.

```python
model_key = "some-model-key"
model_definition = tw.models().get_model_key(model_key)
```

--------------------------------

### Get Discovery Run Results

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves a summary of results from a discovery run, partitioned by result type. Supports filtering by result type, offset, and limit. The output format can be specified as an object.

```python
>>> run = discovery.get_discovery_run_results("1234567890")
>>> print(run.text)
{
    "Dropped": {
        "count": 204,
        "uri": "https://appliance/api/v1.2/discovery/runs/1234567890/results/Dropped"
    },
    "Skipped": {
        "count": 3,
        "uri": "https://appliance/api/v1.2/discovery/runs/1234567890/results/Skipped"
    },
    "Success": {
        "count": 47,
        "uri": "https://appliance/api/v1.2/discovery/runs/1234567890/results/Success"
    }
}
```

--------------------------------

### Get Discovery Status

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves the current status of the discovery process. This method returns a JSON object indicating if the discovery is running and its current status.

```python
discovery.get_discovery.json()
```

--------------------------------

### Get Discovery Run Schedules

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves a list of all scan schedules or a specific schedule if a run ID is provided. This function is used to view existing schedules.

```python
.get_discovery_run_schedule([ _run_id_ ])
```

```python
.get_discovery_run_schedules
```

--------------------------------

### Initialize Tideway Kerberos Client

Source: https://traversys.github.io/Tideway/endpoints/kerberos.html

Demonstrates how to import the tideway library, authenticate with an appliance, and initialize the kerberos object.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
kerberos = tw.kerberos()
```

--------------------------------

### Get Data Kinds

Source: https://traversys.github.io/Tideway/endpoints/data.html

Finds all nodes of a specified kind. Supports pagination with offset and limit, results ID, format specification, and a delete option. Returns a list of nodes matching the kind.

```python
sis = data.get_data_kinds("SoftwareInstance")
print(sis.json()[0]['results'][50])
```

--------------------------------

### Initialize Tideway Appliance and Make API Call (Python)

Source: https://traversys.github.io/Tideway

Demonstrates how to initialize the Tideway appliance object with hostname and authentication token, and then make an API call to retrieve information about the appliance. It shows how to access the URL, status code, and response text from the API result.

```python
import tideway

tw = tideway.appliance('appliance-hostname','auth-token')

print(tw.about().url)
print(tw.about().status_code)
print(tw.about().text)
```

--------------------------------

### Get Data Partitions

Source: https://traversys.github.io/Tideway/endpoints/data.html

Retrieves graph data representing nodes and relationships associated with a given node. This function does not require any parameters and returns a JSON object containing partition information.

```python
partitions = data.get_data_partitions()
from pprint import pprint
pprint(partitions.json())
```

--------------------------------

### Get API Versions Supported by BMC Discovery

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Retrieves the API versions supported by a specific BMC Discovery version. This method returns a JSON object containing API version details.

```python
>>> tw.api_about.json()
{'api_versions': ['1.0', '1.1', '1.2'], 'component': 'REST API', 'product': 'BMC Discovery', 'version': '12.2'}
```

--------------------------------

### Object Initiation

Source: https://traversys.github.io/Tideway/quickstart/initiation.html

How to initialize the Tideway API client instance and configure connection parameters.

```APIDOC
## Object Initiation

### Description
To interact with the Tideway API, you must instantiate a Discovery or Outpost object using your appliance credentials.

### Method
Constructor

### Endpoint
`tideway.appliance(<IP/URL>, <api_token>)` or `tideway.outpost(<IP/URL>, <api_token>)`

### Parameters
#### Path Parameters
- **target** (String) - Required - The Hostname, FQDN or IP Address of the Discovery instance.
- **token** (String) - Required - The authentication token of the API user (do not include "bearer" prefix).

#### Optional Parameters
- **api_version** (String) - Optional - Default: "1.5". The supported version of the API.
- **ssl_verify** (Boolean) - Optional - Default: False. Set to true to verify SSL certificates.

### Available Endpoints
Once initialized, the following top-level endpoints are available:
- `tideway.admin()`
- `tideway.credential()`
- `tideway.data()`
- `tideway.discovery()`
- `tideway.events()`
- `tideway.kerberos()`
- `tideway.knowledge()`
- `tideway.models()`
- `tideway.taxonomy()`
- `tideway.topology()`
- `tideway.vault()`

### Request Example
```python
import tideway
client = tideway.appliance("192.168.1.10", "my_api_token_here")
```
```

--------------------------------

### Initialize Tideway Discovery or Outpost Instance

Source: https://traversys.github.io/Tideway/quickstart/initiation.html

Creates an instance of the Discovery or Outpost object to interact with the API. Requires a target host and an authentication token.

```python
import tideway

# Initialize an appliance or outpost instance
appliance = tideway.appliance("<IP/URL>", "<api_token>")
outpost = tideway.outpost("<IP/URL>", "<api_token>")
```

--------------------------------

### Initialize Tideway Knowledge Object

Source: https://traversys.github.io/Tideway/endpoints/knowledge.html

Establishes a connection to the Tideway appliance and initializes a Knowledge object for subsequent operations. Requires the appliance hostname and an authentication token.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
knowledge = tw.knowledge()
```

--------------------------------

### Get Data Nodes

Source: https://traversys.github.io/Tideway/endpoints/data.html

Retrieves the state of a node using its ID. Optional parameters include relationships, traverse, and flags for more specific data retrieval. Returns node information.

```python
data.get_data_nodes("a1b2c3d4e5f6")
print(node.json()['state']['os_type'])
```

--------------------------------

### Get Topology by Node ID (Python)

Source: https://traversys.github.io/Tideway/endpoints/models.html

Retrieves the topology information for a model identified by its node ID. Similar to get_model_topology, it accepts an optional CSV string of attributes for filtering.

```python
node_id_for_topology = "node-abc"
topology_by_node = tw.models().get_topology_by_node_id(node_id_for_topology)

# With specific attributes
topology_by_node_filtered = tw.models().get_topology_by_node_id(node_id_for_topology, attributes='ip_address')
```

--------------------------------

### Get Data Nodes Graph

Source: https://traversys.github.io/Tideway/endpoints/data.html

Fetches graph data representing nodes and relationships associated with a given node ID. Supports specifying a focus and applying rules for graph visualization.

```python
data.get_data_nodes_graph(__node_id__ [, _focus_ ] [, _apply_rules_ ])
```

--------------------------------

### Get Specific Discovery Run Details

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Retrieves detailed information about a specific, currently processing discovery run using its unique run ID. The output is a JSON list containing details of the run.

```python
run = discovery.get_discovery_run("1234567890")
from pprint import pprint
pprint(run.json())
```

--------------------------------

### Initialize Tideway Appliance or Outpost

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Initiates an Appliance or Outpost object for querying BMC Discovery. Requires target hostname and authentication token. Optional parameters include API version, SSL verification, limit, and offset.

```python
import tideway
tw = tideway.appliance('hostname','auth-token')
```

--------------------------------

### POST /discovery/runs

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Initiates a new snapshot discovery run.

```APIDOC
## POST /discovery/runs

### Description
Creates a new snapshot discovery run with the provided configuration.

### Method
POST

### Endpoint
/discovery/runs

### Request Body
- **ranges** (array) - Required - IP ranges to scan
- **label** (string) - Required - Name for the snapshot
- **scan_level** (string) - Required - Depth of the discovery

### Request Example
{
  "ranges": ["192.168.1.0/24"],
  "label": "Network Snapshot",
  "scan_level": "Full Discovery"
}
```

--------------------------------

### Initialize Tideway Admin Object (Python)

Source: https://traversys.github.io/Tideway/endpoints/admin.html

Initiates an Admin object for the Tideway instance. Requires the target hostname and an authentication token. An optional API version and SSL verification flag can also be provided.

```python
import tideway
tw = tideway.admin('hostname','auth-token')
```

--------------------------------

### Get Licensing Report - Tideway API

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Retrieves the latest signed licensing report. Supports plain text, CSV (zipped raw data), and raw encrypted object formats. The 'content_type' parameter determines the output format.

```text
>>> tw.licensing()
-----BEGIN LICENSE REPORT-----
License report
==============

Report start time: 2021-01-18 23:00:00.409987+00:00
Report end time  : 2021-01-21 23:00:00.410085+00:00
...

```

```text
>>> tw.licensing('csv')

```

```text
>>> tw.licensing('raw')

```

--------------------------------

### Get Specific Credential Type Properties

Source: https://traversys.github.io/Tideway/endpoints/credentials.html

Fetches the detailed properties of a single credential type by its name. This includes its categories, description, groups, label, and API URI. The output is a JSON object representing the credential type's configuration.

```python
>>> ora_creds.credentials.get_vault_credential_type_name("oracle").json()
>>> from pprint import pprint
>>> pprint(ora_creds.json())
```

--------------------------------

### Initialize Tideway Model Object (Python)

Source: https://traversys.github.io/Tideway/endpoints/models.html

Demonstrates how to initialize a Tideway Model object for querying Discovery instances. This requires the appliance hostname and an authentication token. An optional API version and SSL verification flag can also be provided.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
model = tw.models()
```

--------------------------------

### Initialize Tideway Topology Connection

Source: https://traversys.github.io/Tideway/endpoints/topology.html

Initializes a connection to the Tideway appliance to enable topology queries. Requires the appliance hostname and an authentication token.

```python
import tideway
tw = tideway.appliance('appliance-hostname', 'auth-token')
topo = tw.topology()
```

--------------------------------

### Get Vault Credentials by UUID

Source: https://traversys.github.io/Tideway/endpoints/credentials.html

Retrieves a specific credential from the vault using its unique identifier (UUID). If no UUID is provided, it lists all credentials. The output is a JSON object containing credential details, including the types of credentials stored.

```python
>>> creds = credentials.get_vault_credential("e7f00000106c1")
>>> print(creds.json()['types'])
```

--------------------------------

### Post Data Partitions

Source: https://traversys.github.io/Tideway/endpoints/data.html

Creates a new Partition within the system. Requires a JSON object containing the partition details as input.

```python
data.post_data_partitions(__json__)
```

--------------------------------

### Initialize Tideway Discovery Object

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Initializes a Tideway Discovery object for querying a specific appliance. Requires the appliance hostname and an authentication token. Optionally accepts API version, SSL verification status, and limits for requests.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
discovery = tw.discovery()
```

--------------------------------

### Initiate Tideway Data Connection

Source: https://traversys.github.io/Tideway/endpoints/data.html

Initializes the connection to a Tideway appliance to enable data querying. Requires the appliance hostname and an authentication token.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
data = tw.data()
```

--------------------------------

### Initialize Tideway Taxonomy Object

Source: https://traversys.github.io/Tideway/endpoints/taxonomy.html

Initializes a connection to the Tideway appliance using a hostname and authentication token. This object serves as the entry point for all subsequent taxonomy-related API queries.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
taxonomy = tw.taxonomy()
```

--------------------------------

### GET /get_nodes_by_node_id

Source: https://traversys.github.io/Tideway/endpoints/models.html

Retrieves nodes associated with a specific model definition identified by a node ID.

```APIDOC
## GET /get_nodes_by_node_id

### Description
Get nodes for the model definition specified by node id.

### Method
GET

### Endpoint
/get_nodes_by_node_id

### Parameters
#### Query Parameters
- **key** (String) - Required - The node ID to retrieve.
- **results_id** (String) - Optional - The results identifier.
- **delete** (Boolean) - Optional - Whether to delete the node after retrieval (Default: False).
- **kind** (String) - Optional - The kind of node to filter by.

### Request Example
{
  "key": "node_123",
  "delete": false
}

### Response
#### Success Response (200)
- **nodes** (Array) - A list of nodes matching the provided criteria.

#### Response Example
{
  "nodes": [
    {
      "id": "node_123",
      "data": "example_data"
    }
  ]
}
```

--------------------------------

### POST /data/partitions

Source: https://traversys.github.io/Tideway/endpoints/data.html

Creates a new data partition. Requires a JSON payload specifying the partition details.

```APIDOC
## POST /data/partitions

### Description
Create a Partition. This endpoint allows for the creation of new data partitions within the system.

### Method
POST

### Endpoint
/data/partitions

### Parameters
#### Request Body
- **json** (JSON Object) - Required - The JSON payload containing the details for the new partition.

### Request Example
```json
{
  "example": "request body for post_data_partitions"
}
```

### Response
#### Success Response (200)
- **partition_id** (String) - The unique identifier of the newly created partition.

#### Response Example
```json
{
  "example": "response body for post_data_partitions"
}
```
```

--------------------------------

### Initialize Tideway Event Object

Source: https://traversys.github.io/Tideway/endpoints/events.html

Initializes a connection to the Tideway appliance to enable event querying. Requires the appliance hostname and an authentication token.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
events = tw.events()
```

--------------------------------

### Initialize Vault Object

Source: https://traversys.github.io/Tideway/endpoints/vault.html

Initializes a connection to the Tideway Vault. Requires an appliance hostname and an authentication token to establish the session.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
vault = tw.vault()
```

--------------------------------

### Execute Search Query

Source: https://traversys.github.io/Tideway/endpoints/data.html

Performs a search query against the Discovery appliance. Returns paginated results which can be formatted as 'object' or 'tree'.

```python
search = data.search("search Host show os_type process with unique()")
print(search.json())
```

--------------------------------

### Upload Knowledge or Pattern Module

Source: https://traversys.github.io/Tideway/endpoints/knowledge.html

Uploads a TKU or pattern module file to the appliance. Supports optional parameters to toggle automatic activation and allow service restarts upon upload.

```python
knowledge.post_knowledge("TestPattern.tpl","C:/Users/User001/Documents/TestPattern.tpl").ok
```

--------------------------------

### Get Response Elapsed Time

Source: https://traversys.github.io/Tideway/quickstart/responses.html

Measures the time taken to receive the response from the server. This can be helpful for performance monitoring and debugging.

```python
>>> tw.about().elapsed
0:00:00.028861
```

--------------------------------

### Help API

Source: https://traversys.github.io/Tideway/endpoints/appliance.html

Provides help on specific Discovery API endpoints and functions. Outputs a full list by default or details for a specified endpoint.

```APIDOC
## GET /help

### Description
Get help on specific Discovery API endpoint and function to use. Outputs full list by default.

### Method
GET

### Endpoint
`/help`

### Parameters
#### Query Parameters
- **endpoint** (String) - Optional - Description: Any API endpoint from Swagger UI specification.

### Request Example
```
GET /help?endpoint=/vault/credentials/{cred_id}
```

### Response
#### Success Response (200)
- **help_text** (String) - Help information for the specified endpoint or a list of all endpoints.

#### Response Example
```json
{
  "help_text": "Endpoint                      Function                          Description\n----------------------------  --------------------------------  ---------------------------------------------------------------------------------\n/vault/credentials/{cred_id}  deleteCredential(cred_id)         Delete a credential.\n/vault/credentials/{cred_id}  listCredentials(cred_id)          Get the properties of a specific credential.\n/vault/credentials/{cred_id}  updateCredential(cred_id, body)   Updates partial resources of a credential. Missing properties are left unchanged.\n/vault/credentials/{cred_id}  replaceCredential(cred_id, body)  Replaces a single credential. All required credential properties must be present."
}
```
```

--------------------------------

### POST /post_knowledge

Source: https://traversys.github.io/Tideway/endpoints/knowledge.html

Uploads a TKU or pattern module to the appliance.

```APIDOC
## POST /post_knowledge

### Description
Upload a TKU or pattern module to the appliance.

### Method
POST

### Endpoint
/post_knowledge

### Parameters
#### Request Body
- **filename** (String) - Required - The name of the file being uploaded.
- **file** (String) - Required - The file content or path.
- **activate** (Boolean) - Optional - Whether to activate the module (Default: True).
- **allow_restart** (Boolean) - Optional - Whether to allow a restart (Default: False).

### Request Example
{
	"filename": "TestPattern.tpl",
	"file": "C:/Users/User001/Documents/TestPattern.tpl",
	"activate": true,
	"allow_restart": false
}

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the upload was successful.
```

--------------------------------

### Initialize Tideway Appliance Connection

Source: https://traversys.github.io/Tideway/endpoints/credentials.html

Establishes a connection to a Tideway appliance using its hostname and an authentication token. This object is then used to interact with various appliance functionalities, including credentials.

```python
import tideway
tw = tideway.appliance('appliance-hostname','auth-token')
credentials = tw.credentials()
```

--------------------------------

### POST /models

Source: https://traversys.github.io/Tideway/endpoints/models.html

Create a new model or multiple models in the system.

```APIDOC
## POST /models

### Description
Create a new model definition.

### Method
POST

### Endpoint
.post_model(__json__)

### Parameters
#### Request Body
- **json** (JSON Object) - Required - The model definition object

### Request Example
{
  "name": "New Model",
  "type": "static"
}
```

--------------------------------

### POST /data/import

Source: https://traversys.github.io/Tideway/endpoints/data.html

Imports data into the system. Returns the import UUID upon successful initiation of the import process.

```APIDOC
## POST /data/import

### Description
Imports data. Returns the import UUID. This endpoint is used to upload and process data files.

### Method
POST

### Endpoint
/data/import

### Parameters
#### Request Body
- **json** (JSON Object) - Required - The JSON payload specifying the data to be imported.

### Request Example
```json
{
  "example": "request body for post_data_import"
}
```

### Response
#### Success Response (200)
- **import_uuid** (String) - The unique identifier for the import job.

#### Response Example
```json
{
  "example": "response body for post_data_import"
}
```
```

--------------------------------

### Access Tideway Top-Level Endpoints

Source: https://traversys.github.io/Tideway/quickstart/initiation.html

Lists the available top-level service endpoints accessible after initializing the Tideway client.

```python
tideway.admin()
tideway.credential()
tideway.data()
tideway.discovery()
tideway.events()
tideway.kerberos()
tideway.knowledge()
tideway.models()
tideway.taxonomy()
tideway.topology()
tideway.vault()
```

--------------------------------

### GET /data/nodes/{node_id}/graph

Source: https://traversys.github.io/Tideway/endpoints/data.html

Retrieves graph data associated with a node, including nodes and relationships. Allows focusing on specific aspects of the graph.

```APIDOC
## GET /data/nodes/{node_id}/graph

### Description
Graph data represents a set of nodes and relationships that are associated to the given node. This endpoint provides a view of the network graph centered around a specific node.

### Method
GET

### Endpoint
/data/nodes/{node_id}/graph

### Parameters
#### Path Parameters
- **node_id** (JSON Object) - Required - The unique identifier for the node.

#### Query Parameters
- **focus** (String) - Optional - Specifies the focus of the graph data. Options: "software-connected", "software", "infrastructure".
- **apply_rules** (Boolean) - Optional - Defaults to False. If True, applies graph rules.

### Request Example
```json
{
  "example": "request example for get_data_nodes_graph"
}
```

### Response
#### Success Response (200)
- **nodes** (Array) - A list of nodes in the graph.
- **relationships** (Array) - A list of relationships between nodes.

#### Response Example
```json
{
  "example": "response body for get_data_nodes_graph"
}
```
```

--------------------------------

### POST /discovery/runs/schedules

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Adds a new scan schedule.

```APIDOC
## POST /discovery/runs/schedules

### Description
Add a new scan schedule.

### Method
POST

### Endpoint
`/discovery/runs/schedules`

### Parameters
#### Request Body
- **json** (JSON Object) - Required - The schedule details.
  - **run_id** (String) - Required - The ID of the discovery run.
  - **schedule** (String) - Required - The schedule details (e.g., "daily at 02:00").

### Request Example
```json
{
  "run_id": "run-abc",
  "schedule": "daily at 02:00"
}
```

### Response
#### Success Response (200)
- **schedule_id** (String) - The ID of the newly created scan schedule.

#### Response Example
```json
{
  "schedule_id": "schedule-456"
}
```
```

--------------------------------

### Create New Snapshot Discovery Run

Source: https://traversys.github.io/Tideway/endpoints/discovery.html

Initiates a new snapshot discovery run. Requires a JSON payload specifying the IP ranges, a label for the run, and the scan level. Returns a boolean indicating success.

```python
discovery.post_discovery_run({"ranges":[ "192.168.1.0/24" ],"label":"Network Snapshot","scan_level":"Full Discovery"}).ok
```
Tokens:
Raw