API docs by Redocly

Ziggiz Platform API (1.0.0)

Download OpenAPI specification:

A service for interacting with ziggiz

applications

A service for working with ziggiz Applications.

listApplications applications

List Applications.

Authorizations:
jwt_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

bastion

A service for Bastion controller management and communication.

downloadBastionImage bastion

Stream downloads the docker image for the bastion controller

Authorizations:
jwt_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "url": "Ut dolorum voluptatem expedita modi omnis."
}

listBastionGroups bastion

List all bastion groups (paginated).

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Enum: "Bastions" "DatasourceInstances" "DatasourceInstances.DatasetInstances" "EventHubConnections"
Example: relations=Bastions&relations=DatasourceInstances&relations=DatasetInstances&relations=EventHubConnections

Relations to fetch with bastion groups

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createBastionGroup bastion

Create a new bastion group.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
object

Bastion configuration data

description
string

Description of the bastion group

name
required
string non-empty

Name of the bastion group

Responses

Request samples

Content type
application/json
{
  • "bastion_config": {
    },
  • "description": "Eligendi dolores.",
  • "name": "Production Bastions"
}

Response samples

Content type
application/json
{
  • "bastion_config": {
    },
  • "bastion_config_hash": "Consequatur id distinctio.",
  • "bastions": [
    ],
  • "command": "Nemo sit.",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "datasource_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "fluent_bit_config": "Dolore laboriosam qui non.",
  • "fluent_bit_config_hash": "Quo fugit iure et similique quod.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "image": "Enim voluptas.",
  • "name": "My Resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteBastionGroup bastion

Delete a bastion group.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 6faec734-e763-4de2-bb77-9ca1530bb1e0

ID of the bastion group

Responses

getBastionGroup bastion

Get a specific bastion group.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 7ec47f1e-b55a-4dbb-bbd5-85ae3bc699f5

ID of the bastion group

query Parameters
relations
Array of strings
Items Enum: "Bastions" "DatasourceInstances" "DatasourceInstances.DatasetInstances" "EventHubConnections"
Example: relations=Bastions&relations=DatasourceInstances&relations=DatasetInstances&relations=EventHubConnections

Relations to fetch with bastion groups

Responses

Response samples

Content type
application/json
{
  • "bastion_config": {
    },
  • "bastion_config_hash": "Et unde quidem quibusdam aut error.",
  • "bastions": [
    ],
  • "command": "Error veritatis enim sed sequi laborum.",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "datasource_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "fluent_bit_config": "Culpa iure quas.",
  • "fluent_bit_config_hash": "Odit est voluptatem aut maxime sed nobis.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "image": "Fugiat quasi.",
  • "name": "My Resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateBastionGroup bastion

Update a bastion group's configuration.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 46db1cc2-7540-403a-9cca-2431e330367d

ID of the bastion group

Request Body schema: application/json
required
object

Bastion configuration data

description
string

Description of the bastion group

name
string non-empty

Name of the bastion group

Responses

Request samples

Content type
application/json
{
  • "bastion_config": {
    },
  • "description": "Quis qui omnis.",
  • "name": "Production Bastions"
}

Response samples

Content type
application/json
{
  • "bastion_config": {
    },
  • "bastion_config_hash": "Qui repellat sunt quis eos totam.",
  • "bastions": [
    ],
  • "command": "Commodi ipsam blanditiis.",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "datasource_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "fluent_bit_config": "Et sit quasi qui laboriosam facilis modi.",
  • "fluent_bit_config_hash": "Eius similique in aut id et architecto.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "image": "Necessitatibus rerum culpa qui est.",
  • "name": "My Resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

getBastionGroupHealth bastion

Get the aggregate health status of all bastions in a group.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 5b4ec047-8ccc-4f77-af78-77edf973d29b

ID of the bastion group

Responses

Response samples

Content type
application/json
{
  • "bastions_health": [
    ],
  • "group_id": "eac69b18-ef3e-4582-ba95-e38128bd1ee0",
  • "total_bastions": 143331447,
  • "total_healthy": 510233085
}

listBastions bastion

List all Bastions (paginated).

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

deleteBastion bastion

Delete a Bastion by GUID.

Authorizations:
jwt_header_Authorization
path Parameters
guid
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

GUID of the Bastion to delete

Responses

getBastionByGUID bastion

Retrieve a Bastion by GUID.

Authorizations:
jwt_header_Authorization
path Parameters
guid
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

GUID of the Bastion

Responses

Response samples

Content type
application/json
{
  • "bastion_health_status": "online",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "fluent_bit_health_status": "offline",
  • "group": {
    },
  • "group_id": "8e447b27-8108-49b1-87d4-1c7937115e19",
  • "guid": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "hostname": "bastion-host",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "ip": "192.168.1.1",
  • "memory": 8589934592,
  • "name": "Main Bastion",
  • "num_cores": 4,
  • "storage": 128849018880,
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateBastion bastion

Update a Bastion by GUID.

Authorizations:
jwt_header_Authorization
path Parameters
guid
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

GUID of the Bastion

Request Body schema: application/json
required
hostname
string

Hostname of the Bastion

ip
string <ip>

IP address of the Bastion

name
string non-empty

Name of the Bastion

Responses

Request samples

Content type
application/json
{
  • "hostname": "bastion-host",
  • "ip": "192.168.1.1",
  • "name": "Main Bastion"
}

Response samples

Content type
application/json
{
  • "bastion_health_status": "offline",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "fluent_bit_health_status": "online",
  • "group": {
    },
  • "group_id": "c8a3b3fa-d8a2-4f59-898a-2c250a909fb5",
  • "guid": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "hostname": "bastion-host",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "ip": "192.168.1.1",
  • "memory": 8589934592,
  • "name": "Main Bastion",
  • "num_cores": 4,
  • "storage": 128849018880,
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

sendCommandToBastion bastion

Send a command to a Bastion.

Authorizations:
jwt_header_Authorization
path Parameters
guid
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

GUID of the Bastion

Request Body schema: application/json
required
required
object (ServerCommandRequestsHTTP2)

Command to send to Bastion via HTTP.

Responses

Request samples

Content type
application/json
{
  • "command": {
    }
}

Response samples

Content type
application/json
{
  • "command": {
    }
}

getBastionLogs bastion

Retrieve logs for a Bastion by GUID with optional filtering parameters.

Authorizations:
jwt_header_Authorization
path Parameters
guid
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

GUID of the Bastion

query Parameters
search
string
Example: search=connection established

Search term to filter log messages

start
string <date-time>
Example: start=2023-03-14T00:00:00.000Z

Start timestamp for filtering logs

end
string <date-time>
Example: end=2023-03-14T23:59:59.999Z

End timestamp for filtering logs

level
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
Example: level=ERROR

Filter logs by level

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

human-analytics

A service for working with ziggiz Human Analytics Environments.

These environments allow users to select semantic datasets and dataset instances along with a time period. The service will then load this data into a databricks environment for analysis by users.

listHumanAnalyticsEnvironments human-analytics

List a page of human analytics environments.

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Enum: "DatasetInstances" "SemanticDatasets" "ExternalConnections"
Example: relations=Datasets

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createHumanAnalyticsEnvironment human-analytics

Create a new human analytics environment.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
Array of objects (CreateHumanAnalyticsDatasetInstance)

The dataset instances directly included in the Human Analytics Environment.

description
required
string [ 6 .. 1024 ] characters

The description of the resource.

external_connections
Array of strings <uuid> [ items <uuid > ]

The external connection IDs to grant access to the environment.

name
required
string [ 3 .. 255 ] characters

The name of the resource.

Array of objects (CreateHumanAnalyticsSemanticDataset)

The semantic datasets to included in the Human Analytics Environment.

Responses

Request samples

Content type
application/json
{
  • "dataset_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "external_connections": [
    ],
  • "name": "My Resource",
  • "semantic_datasets": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "databricks_url": "Esse quas.",
  • "dataset_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "error_message": "Quos ut atque quia fugiat.",
  • "external_connections": [
    ],
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_datasets": [
    ],
  • "status": "Pending",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

getHumanAnalyticsEnvironmentSize human-analytics

Estimate the size of a human analytics environment.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
Array of objects (CreateHumanAnalyticsDatasetInstance)

The dataset instances directly included in the Human Analytics Environment.

Array of objects (CreateHumanAnalyticsSemanticDataset)

The semantic datasets to included in the Human Analytics Environment.

Responses

Request samples

Content type
application/json
{
  • "dataset_instances": [
    ],
  • "semantic_datasets": [
    ]
}

Response samples

Content type
application/json
{
  • "bytes": 6950465018793844000
}

deleteHumanAnalyticsEnvironment human-analytics

Delete an existing human analytics environment by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the human analytics environment

Responses

getHumanAnalyticsEnvironment human-analytics

Get a human analytics environment by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the human analytics environment

query Parameters
relations
Array of strings
Items Enum: "DatasetInstances" "SemanticDatasets" "ExternalConnections"
Example: relations=Datasets

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "databricks_url": "Quia dolorum et perspiciatis.",
  • "dataset_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "error_message": "Soluta voluptatem temporibus aliquid doloremque harum.",
  • "external_connections": [
    ],
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_datasets": [
    ],
  • "status": "Pending",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateHumanAnalyticsEnvironment human-analytics

Update an existing human analytics environment.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the human analytics environment to update

Request Body schema: application/json
required
external_connections
Array of strings <uuid> [ items <uuid > ]

The external connection IDs to grant access to the environment.

Responses

Request samples

Content type
application/json
{
  • "external_connections": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "databricks_url": "Accusamus est ut.",
  • "dataset_instances": [
    ],
  • "description": "A useful description of the resource.",
  • "error_message": "Et voluptas temporibus.",
  • "external_connections": [
    ],
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_datasets": [
    ],
  • "status": "Pending",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

datasets

A service for working with dataset templates and instances as well as semantic datasets.

listDatasetInstances datasets

List a page of dataset instances.

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Enum: "DatasetTemplate" "ParentDatasourceInstance" "StreamMetrics"
Example: relations=ParentDatasourceInstance&relations=DatasetTemplate

Relations to include in results

metrics_start_ts
string <date-time>
Example: metrics_start_ts=2025-01-01T12:00:00Z

Start timestamp for stream metrics if 'Metrics' relationship is given. Defaults to an hour ago if not provided

metrics_end_ts
string <date-time>
Example: metrics_end_ts=2025-01-02T12:00:00Z

Start timestamp for stream metrics if 'Metrics' relationship is given. Defaults to now if not provided

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

getDatasetInstance datasets

Retrieve a dataset instance by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the dataset instance

query Parameters
relations
Array of strings
Items Enum: "DatasetTemplate" "ParentDatasourceInstance" "StreamMetrics"
Example: relations=ParentDatasourceInstance&relations=DatasetTemplate

Relations to include in results

metrics_start_ts
string <date-time>
Example: metrics_start_ts=2025-01-01T12:00:00Z

Start timestamp for stream metrics if 'Metrics' relationship is given. Defaults to an hour ago if not provided

metrics_end_ts
string <date-time>
Example: metrics_end_ts=2025-01-02T12:00:00Z

Start timestamp for stream metrics if 'Metrics' relationship is given. Defaults to now if not provided

Responses

Response samples

Content type
application/json
{
  • "conn_id": "12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_template": {
    },
  • "dataset_template_id": "12345678-1234-1234-1234-123456789012",
  • "datasource_instance_name": "Parent Datasource Instance Name",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Dataset",
  • "parent_datasource_instance": {
    },
  • "parent_datasource_instance_id": "12345678-1234-1234-1234-123456789012",
  • "stream_metrics": [
    ],
  • "topic": "12345678-1234-1234-1234-123456789012",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

listSemanticDatasets datasets

List a page of semantic datasets.

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createSemanticDataset datasets

Create a semantic dataset.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
description
required
string [ 6 .. 1024 ] characters

The description of the resource.

name
required
string [ 3 .. 255 ] characters

The user facing name of the resource.

parent_semantic_datasource_id
required
string <uuid>

The unique identifier for the semantic datasource that this dataset belongs to.

required
object

A JSON structure describing the schema of a dataset using Delta Lake data types.

Responses

Request samples

Content type
application/json
{
  • "description": "A useful description of the resource.",
  • "name": "My Resource",
  • "parent_semantic_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "schema": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "parent_semantic_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "safe_name": "my_resource",
  • "schema": {
    },
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteSemanticDataset datasets

Delete a semantic dataset by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Semantic Dataset

Responses

getSemanticDataset datasets

Retrieve a semantic dataset by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the semantic dataset

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "parent_semantic_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "safe_name": "my_resource",
  • "schema": {
    },
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateSemanticDataset datasets

Update an existing semantic dataset.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the Semantic Dataset

Request Body schema: application/json
required
description
string [ 6 .. 1024 ] characters

The description of the resource.

name
string [ 3 .. 255 ] characters

The user facing name of the resource.

object

A JSON structure describing the schema of a dataset using Delta Lake data types.

Responses

Request samples

Content type
application/json
{
  • "description": "A useful description of the resource.",
  • "name": "My Resource",
  • "schema": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "parent_semantic_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "safe_name": "my_resource",
  • "schema": {
    },
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

listDatasetTemplates datasets

List a page of dataset templates.

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Enum: "Mappings" "Instances"
Example: relations=Mappings&relations=Instances

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

getDatasetTemplate datasets

Retrieve a dataset template by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the dataset template

query Parameters
relations
Array of strings
Items Enum: "Mappings" "Instances"
Example: relations=Mappings&relations=Instances

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "instances": [
    ],
  • "mappings": [
    ],
  • "name": "My Resource",
  • "num_semantic_datasets": 3,
  • "num_semantic_datasources": 2,
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "routing_hints": [
    ],
  • "safe_name": "my_resource",
  • "schema": {
    },
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateDatasetTemplate datasets

Update an existing dataset template.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the Dataset Template

Request Body schema: application/json
required
description
string [ 6 .. 1024 ] characters

The description of the resource.

name
string [ 3 .. 255 ] characters

The user facing name of the resource.

Responses

Request samples

Content type
application/json
{
  • "description": "A useful description of the resource.",
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "instances": [
    ],
  • "mappings": [
    ],
  • "name": "My Resource",
  • "num_semantic_datasets": 3,
  • "num_semantic_datasources": 2,
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "routing_hints": [
    ],
  • "safe_name": "my_resource",
  • "schema": {
    },
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

datasources

A service for working with datasource templates and instances as well as semantic datasources.

listDatasourceInstances datasources

List a page of datasource instances

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Enum: "DatasetInstances" "OnboardingInfo" "BastionGroup"
Example: relations=DatasetInstances&relations=BastionGroup

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createDatasourceInstance datasources

Create a new Datasource Instance. This will also instantiate the datasets templates for the new instance

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
bastion_group_id
required
string <uuid>

The unique identifier for the bastion group that this datasource instance belongs to.

description
required
string [ 6 .. 1024 ] characters

The description of the resource.

name
required
string [ 3 .. 255 ] characters

The user facing name of the resource.

parent_datasource_id
required
string <uuid>

The unique identifier for the datasource instance.

Responses

Request samples

Content type
application/json
{
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "description": "A useful description of the resource.",
  • "name": "My Resource",
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012"
}

Response samples

Content type
application/json
{
  • "bastion_group": {
    },
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_instances": [
    ],
  • "datasource_template_name": "Parent Datasource Template Name",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "port": 6240,
  • "safe_name": "my_resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteDatasourceInstance datasources

Delete a Datasource Instance by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Datasource Instance

Responses

getDatasourceInstance datasources

Get a Datasource Instance by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the datasource Instance

query Parameters
relations
Array of strings
Items Enum: "DatasetInstances" "OnboardingInfo" "BastionGroup"
Example: relations=DatasetInstances&relations=BastionGroup

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "bastion_group": {
    },
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_instances": [
    ],
  • "datasource_template_name": "Parent Datasource Template Name",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "port": 6240,
  • "safe_name": "my_resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateDatasourceInstance datasources

Update an existing Datasource Instance.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the datasource instance

Request Body schema: application/json
required
bastion_group_id
string <uuid>

The unique identifier for the bastion group that this datasource instance belongs to.

description
string [ 6 .. 1024 ] characters

The description of the resource.

name
string [ 3 .. 255 ] characters

The user facing name of the resource.

Responses

Request samples

Content type
application/json
{
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "description": "A useful description of the resource.",
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "bastion_group": {
    },
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_instances": [
    ],
  • "datasource_template_name": "Parent Datasource Template Name",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "port": 6240,
  • "safe_name": "my_resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

getDatasourceInstanceTransportMetrics datasources

Get the bytes received over a period of time for a datasource instance

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the datasource Instance

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

listDatasourcesBeingOnboarded datasources

Get a paginated list of datasources that have yet to complete onboarding.

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

beginOnboarding datasources

Begin the onboarding of a new datasource. This will create a new datasource instance and template so the schema can be inferred

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
bastion_group_id
required
string

The ID of the bastion group to associate with the datasource instance.

description
required
string [ 6 .. 1024 ] characters

The description of the resource.

name
required
string [ 3 .. 255 ] characters

The name of the resource.

Responses

Request samples

Content type
application/json
{
  • "bastion_group_id": "Ipsa velit consequatur quo et autem.",
  • "description": "A useful description of the resource.",
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "bastion_group": {
    },
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_instances": [
    ],
  • "datasource_template_name": "Parent Datasource Template Name",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "port": 6240,
  • "safe_name": "my_resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

cancelOnboarding datasources

Cancel the onboarding of a datasource that has not been fully onboarded.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the datasource template to cancel onboarding for

Responses

completeOnboarding datasources

Complete the onboarding of a new datasource by finalising its datasets and schemas.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the datasource template to complete onboarding for

Request Body schema: application/json
required
required
Array of objects (CompleteOnboardingDataset) non-empty

Finalised datasets for onboarding

Responses

Request samples

Content type
application/json
{
  • "datasets": [
    ]
}

Response samples

Content type
application/json
{
  • "bastion_group": {
    },
  • "bastion_group_id": "12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_instances": [
    ],
  • "datasource_template_name": "Parent Datasource Template Name",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "parent_datasource_id": "12345678-1234-1234-1234-123456789012",
  • "port": 6240,
  • "safe_name": "my_resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

listSemanticDatasources datasources

List a page of Semantic Datasources

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Value: "SemanticDatasets"
Example: relations=SemanticDatasets

Relations to include in results

instances_only
boolean
Default: false
Example: instances_only=true

Whether to only return semantic datasources that have datasource instances mapped to them.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createSemanticDatasource datasources

Create a new Semantic Datasource.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
description
required
string [ 6 .. 1024 ] characters

The description of the resource.

layer
required
integer <int64> >= 1

The layer of the semantic datasource in the semantic hierarchy.

name
required
string [ 3 .. 255 ] characters

The user facing name of the resource.

Responses

Request samples

Content type
application/json
{
  • "description": "A useful description of the resource.",
  • "layer": 1,
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "is_editable": true,
  • "layer": 1,
  • "name": "My Resource",
  • "safe_name": "my_resource",
  • "semantic_datasets": [
    ],
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteSemanticDatasource datasources

Delete a Semantic Datasource by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Semantic Datasource

Responses

getSemanticDatasource datasources

Get a Semantic Datasource by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the semantic datasource

query Parameters
relations
Array of strings
Items Value: "SemanticDatasets"
Example: relations=SemanticDatasets

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "is_editable": true,
  • "layer": 1,
  • "name": "My Resource",
  • "safe_name": "my_resource",
  • "semantic_datasets": [
    ],
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateSemanticDatasource datasources

Update an existing Semantic Datasource.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the Semantic Datasource

Request Body schema: application/json
required
description
string [ 6 .. 1024 ] characters

The description of the resource.

name
string [ 3 .. 255 ] characters

The user facing name of the resource.

Responses

Request samples

Content type
application/json
{
  • "description": "A useful description of the resource.",
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "is_editable": true,
  • "layer": 1,
  • "name": "My Resource",
  • "safe_name": "my_resource",
  • "semantic_datasets": [
    ],
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

listDatasourceTemplates datasources

List a page of datasource templates

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

relations
Array of strings
Items Enum: "DatasetTemplates" "Instances" "OnboardingInfo"
Example: relations=Instances&relations=DatasetTemplates

Relations to include in results

instances_only
boolean
Default: false
Example: instances_only=true

Whether to only return datasource templates that have instances associated with them

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

deleteDatasourceTemplate datasources

Delete a Datasource Template by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Datasource Template

Responses

getDatasourceTemplate datasources

Get a Datasource Template by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the datasource template

query Parameters
relations
Array of strings
Items Enum: "DatasetTemplates" "Instances" "OnboardingInfo"
Example: relations=Instances&relations=DatasetTemplates

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_templates": [
    ],
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "instances": [
    ],
  • "is_editable": false,
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "routing_hints": [
    ],
  • "safe_name": "my_resource",
  • "tags": [
    ],
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateDatasourceTemplate datasources

Update an existing Datasource Template.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the Datasource Template

Request Body schema: application/json
required
description
string [ 6 .. 1024 ] characters

The description of the resource.

name
string [ 3 .. 255 ] characters

The user facing name of the resource.

tags
Array of strings [ 0 .. 32 ] items [ items [ 2 .. 32 ] characters ]

A list of tags to associate with the resource.

Responses

Request samples

Content type
application/json
{
  • "description": "A useful description of the resource.",
  • "name": "My Resource",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dataset_templates": [
    ],
  • "description": "A useful description of the resource.",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "instances": [
    ],
  • "is_editable": true,
  • "name": "My Resource",
  • "onboarding_info": {
    },
  • "routing_hints": [
    ],
  • "safe_name": "my_resource",
  • "tags": [
    ],
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

mappings

A service for working with semantic mappings. It can be used to map dataset templates to semantic datasets and to map semantic datasets to other semantic datasets.

listDatasetMappings mappings

List a page of dataset mappings

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

datasource_id
string <uuid>
Example: datasource_id=1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the datasource template to filter by

dataset_id
string <uuid>
Example: dataset_id=1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the dataset template to filter by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createDatasetMapping mappings

Create a new dataset mapping

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
dst_col_name
required
string [ 2 .. 255 ] characters

The name of the field in the semantic dataset that is being mapped to.

dst_id
required
string <uuid>

The ID of the semantic dataset that is being mapped to.

filter_expr
string

A filter expression to apply to the source dataset to filter results that are mapped.

src_col_expr
required
string [ 2 .. 1024 ] characters

The field or select expression representing the data to be mapped from.

src_id
required
string <uuid>

The ID of the dataset template that is being mapped from.

Responses

Request samples

Content type
application/json
{
  • "dst_col_name": "src_ip",
  • "dst_id": "6d60280c-3afa-4b70-9181-0f0e68a34fba",
  • "filter_expr": "service = 'DNS'",
  • "src_col_expr": "src_ip",
  • "src_id": "81aaf7b9-c1b1-4d84-9f78-f346b5332ba9"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dst_col_name": "src_ip",
  • "dst_id": "85ede9d2-5761-4a96-ab03-9af3719d5571",
  • "dst_semantic_dataset_name": "Traffic",
  • "dst_semantic_datasource_name": "Firewall",
  • "filter_expr": "service = 'DNS'",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "src_col_expr": "src_ip",
  • "src_cols": [
    ],
  • "src_dataset_template_name": "Traffic",
  • "src_datasource_template_name": "Fortigate",
  • "src_id": "5a3740a0-ce19-4045-a95f-e6e1052716d8",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteDatasetMapping mappings

Delete a dataset mapping by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Dataset Mapping

Responses

getDatasetMapping mappings

Get a dataset mapping by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the dataset mapping

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dst_col_name": "src_ip",
  • "dst_id": "506734c1-8aa0-4552-81b5-e1cf3c22ab1c",
  • "dst_semantic_dataset_name": "Traffic",
  • "dst_semantic_datasource_name": "Firewall",
  • "filter_expr": "service = 'DNS'",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "src_col_expr": "src_ip",
  • "src_cols": [
    ],
  • "src_dataset_template_name": "Traffic",
  • "src_datasource_template_name": "Fortigate",
  • "src_id": "3ba4b1c2-1d95-426e-87a4-528f09e3acbf",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateDatasetMapping mappings

Update an existing dataset mapping

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the dataset mapping

Request Body schema: application/json
required
dst_col_name
string [ 2 .. 255 ] characters

The name of the field in the semantic dataset that is being mapped to.

dst_id
string <uuid>

The ID of the semantic dataset that is being mapped to.

filter_expr
string

A filter expression to apply to the source dataset to filter results that are mapped.

src_col_expr
string [ 2 .. 1024 ] characters

The field or select expression representing the data to be mapped from.

src_id
string <uuid>

The ID of the dataset template that is being mapped from.

Responses

Request samples

Content type
application/json
{
  • "dst_col_name": "src_ip",
  • "dst_id": "ce4a7caa-5bf3-4346-ade4-e18fbf60079b",
  • "filter_expr": "service = 'DNS'",
  • "src_col_expr": "src_ip",
  • "src_id": "6706112a-eca2-4806-a8dd-e9dda4aa2474"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dst_col_name": "src_ip",
  • "dst_id": "f6497a1b-7815-419d-98e7-da33626d5d83",
  • "dst_semantic_dataset_name": "Traffic",
  • "dst_semantic_datasource_name": "Firewall",
  • "filter_expr": "service = 'DNS'",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "src_col_expr": "src_ip",
  • "src_cols": [
    ],
  • "src_dataset_template_name": "Traffic",
  • "src_datasource_template_name": "Fortigate",
  • "src_id": "8ab8531b-b530-476c-9dac-071361484497",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

getDatasetEdges mappings

Get the source and destination IDs of all the datasets that connect to each other both semantic and template. Includes application edges.

Authorizations:
jwt_header_Authorization
query Parameters
instances_only
boolean
Default: false
Example: instances_only=true

Whether to only return edges that resolve back to datasource instances.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getDatasourceEdges mappings

Get the source and destination IDs of all the datasources that connect to each other both semantic and template. Includes application edges.

Authorizations:
jwt_header_Authorization
query Parameters
instances_only
boolean
Default: false
Example: instances_only=true

Whether to only return edges that resolve back to datasource instances.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

listSemanticMappings mappings

List a page of semantic mappings

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

datasource_id
string <uuid>
Example: datasource_id=1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the semantic datasource to filter by

dataset_id
string <uuid>
Example: dataset_id=1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the semantic dataset to filter by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createSemanticMapping mappings

Create a new semantic mapping

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
dst_col_name
required
string [ 2 .. 255 ] characters

The name of the field in the semantic dataset that is being mapped to.

dst_id
required
string <uuid>

The ID of the semantic dataset that is being mapped to.

filter_expr
string

A filter expression to apply to the source dataset to filter results that are mapped.

src_col_expr
required
string [ 2 .. 1024 ] characters

The field or select expression representing the data to be mapped from.

src_id
required
string <uuid>

The ID of the dataset template that is being mapped from.

Responses

Request samples

Content type
application/json
{
  • "dst_col_name": "src_ip",
  • "dst_id": "e3e60686-b629-4c7a-beb1-717767c09a03",
  • "filter_expr": "service = 'DNS'",
  • "src_col_expr": "src_ip",
  • "src_id": "2be9007a-16f0-4320-b22d-82b3fbb58aa0"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dst_col_name": "src_ip",
  • "dst_id": "94fb6168-612c-4ff9-a34d-499a13913f3c",
  • "dst_semantic_dataset_name": "DNS",
  • "dst_semantic_datasource_name": "Network Activity",
  • "filter_expr": "service = 'DNS'",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "src_col_expr": "src_ip",
  • "src_cols": [
    ],
  • "src_id": "bb3f33e3-bb7b-437f-9514-7297c01bae4c",
  • "src_semantic_dataset_name": "Traffic",
  • "src_semantic_datasource_name": "Firewall",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteSemanticMapping mappings

Delete a semantic mapping by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Semantic Mapping

Responses

getSemanticMapping mappings

Get a semantic mapping by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the semantic mapping

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dst_col_name": "src_ip",
  • "dst_id": "ee192002-8587-49a9-9200-059772607ff9",
  • "dst_semantic_dataset_name": "DNS",
  • "dst_semantic_datasource_name": "Network Activity",
  • "filter_expr": "service = 'DNS'",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "src_col_expr": "src_ip",
  • "src_cols": [
    ],
  • "src_id": "ff606b65-ab11-4889-889f-e634095e7ffb",
  • "src_semantic_dataset_name": "Traffic",
  • "src_semantic_datasource_name": "Firewall",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateSemanticMapping mappings

Update an existing semantic mapping

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the semantic mapping

Request Body schema: application/json
required
dst_col_name
string [ 2 .. 255 ] characters

The name of the field in the semantic dataset that is being mapped to.

dst_id
string <uuid>

The ID of the semantic dataset that is being mapped to.

filter_expr
string

A filter expression to apply to the source dataset to filter results that are mapped.

src_col_expr
string [ 2 .. 1024 ] characters

The field or select expression representing the data to be mapped from.

src_id
string <uuid>

The ID of the dataset template that is being mapped from.

Responses

Request samples

Content type
application/json
{
  • "dst_col_name": "src_ip",
  • "dst_id": "2aee7905-b41d-4e92-a087-022726b2e528",
  • "filter_expr": "service = 'DNS'",
  • "src_col_expr": "src_ip",
  • "src_id": "b7fa2571-4274-4c45-b3b2-11def3e31f04"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "dst_col_name": "src_ip",
  • "dst_id": "ab80ce92-55c5-45c7-b734-6751030d892c",
  • "dst_semantic_dataset_name": "DNS",
  • "dst_semantic_datasource_name": "Network Activity",
  • "filter_expr": "service = 'DNS'",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "src_col_expr": "src_ip",
  • "src_cols": [
    ],
  • "src_id": "e46200b9-e2e4-4b02-96e9-cc9363772655",
  • "src_semantic_dataset_name": "Traffic",
  • "src_semantic_datasource_name": "Firewall",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

getMappingTree mappings

Get all related edges for datasources and datasets for a given datasource id. Includes application edges.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of a semantic datasource or datasource template

query Parameters
type
required
string
Enum: "SemanticDatasource" "DatasourceTemplate"
Example: type=SemanticDatasource

The type of the ID provided

instances_only
boolean
Default: false
Example: instances_only=true

Whether to only return mappings that resolve back to datasource instances.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

metrics

A service for retrieving metrics data for the platform.

getSavings metrics

Get the data and cost savings for the last 24hrs and 7 days.

Authorizations:
jwt_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "bytes_saved_24hr": 1073741824,
  • "bytes_saved_7days": 7516192768,
  • "usd_saved_24hr": 100,
  • "usd_saved_7days": 1000
}

security

A service for working with the ziggiz security application.

listAlerts security

List a page of alerts aggregated over a period of time.

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

time_range
string
Default: "24h"
Enum: "1h" "24h" "7d" "30d"
Example: time_range=24h

Last X amount of time to show alerts by.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

listAlertsBucketed security

List a page of alerts bucketed over the specified time range.

Authorizations:
jwt_header_Authorization
query Parameters
time_range
string
Default: "24h"
Enum: "1h" "24h" "7d" "30d"
Example: time_range=24h

Last X amount of time to show alerts by.

Responses

Response samples

Content type
application/json
{
  • "1986-06-21T03:14:06Z": [
    ],
  • "2014-10-22T03:59:08Z": [
    ]
}

getDashboardURL security

Returns the embed link for the security dashboard

Authorizations:
jwt_header_Authorization

Responses

Response samples

listTriggeredAlerts security

List a page of alerts for a given rule id.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the rule to get alerts for

query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

listRules security

List a page of security rules

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

search
string
Example: search=failed login attempts

Search term to filter rules

tags
Array of strings
Example: tags=attack.command-and-control

Tags to filter rules by

status
string
Enum: "enabled" "disabled"
Example: status=disabled

Filter by rule status

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": true,
  • "has_prev": false,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

createRule security

Create a new Security Rule.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
definition
required
string >= 6 characters

The rule definition.

description
required
string [ 6 .. 1024 ] characters

The description of the resource.

enabled
boolean

Is the rule enabled?

name
required
string [ 3 .. 255 ] characters

The name of the resource.

tags
Array of strings [ 0 .. 32 ] items [ items [ 2 .. 32 ] characters ]

A list of tags to associate with the resource.

type
required
string
Enum: "sql" "sigma"

The type of rule definition.

Responses

Request samples

Content type
application/json
{
  • "definition": "SELECT * FROM table WHERE field = 'value'",
  • "description": "A useful description of the resource.",
  • "enabled": true,
  • "name": "My Resource",
  • "tags": [
    ],
  • "type": "sql"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "definition": "SELECT * FROM table WHERE field = 'value'",
  • "description": "A useful description of the resource.",
  • "enabled": true,
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_dataset_id": "12345678-1234-1234-1234-123456789012",
  • "tags": [
    ],
  • "type": "sql",
  • "updated_at": "2023-03-14T16:34:00.000Z",
  • "use_case_id": "7249d097-6110-4b0f-8699-0b58d832e5a6"
}

deleteRule security

Delete a Security Rule by ID.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the Security Rule

Responses

getRule security

Get a Security Rule by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the security rule

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "definition": "SELECT * FROM table WHERE field = 'value'",
  • "description": "A useful description of the resource.",
  • "enabled": true,
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_dataset_id": "12345678-1234-1234-1234-123456789012",
  • "tags": [
    ],
  • "type": "sql",
  • "updated_at": "2023-03-14T16:34:00.000Z",
  • "use_case_id": "083a1326-c8e5-4eac-8503-1ecdb2270b9e"
}

updateRule security

Update an existing Security Rule.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Examples:
  • 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45 - default

ID of the security rule

Request Body schema: application/json
required
definition
string >= 6 characters

The rule definition.

description
string [ 6 .. 1024 ] characters

The description of the resource.

enabled
boolean

Is the rule enabled?

name
string [ 3 .. 255 ] characters

The name of the resource.

tags
Array of strings [ 0 .. 32 ] items [ items [ 2 .. 32 ] characters ]

A list of tags to associate with the resource.

type
string
Enum: "sql" "sigma"

The type of rule definition.

Responses

Request samples

Content type
application/json
{
  • "definition": "SELECT * FROM table WHERE field = 'value'",
  • "description": "A useful description of the resource.",
  • "enabled": false,
  • "name": "My Resource",
  • "tags": [
    ],
  • "type": "sql"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "definition": "SELECT * FROM table WHERE field = 'value'",
  • "description": "A useful description of the resource.",
  • "enabled": true,
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_dataset_id": "12345678-1234-1234-1234-123456789012",
  • "tags": [
    ],
  • "type": "sql",
  • "updated_at": "2023-03-14T16:34:00.000Z",
  • "use_case_id": "dc638dfd-1f14-40a9-b359-436be8dd85d0"
}

listUseCases security

List a page of pre-defined security use cases

Authorizations:
jwt_header_Authorization
query Parameters
page
integer <int64> >= 1
Default: 1
Example: page=1

The page number requested.

limit
integer <int64> [ 1 .. 10000 ]
Default: 20
Example: limit=10

Results per page.

search
string
Example: search=failed login attempts

Search term to filter use cases

tags
Array of strings
Example: tags=attack.command-and-control

Tags to filter use cases by

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_next": false,
  • "has_prev": true,
  • "page": 1,
  • "per_page": 20,
  • "total": 100,
  • "total_pages": 5
}

getUseCase security

Get a pre-defined security use case by ID

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the use case

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "description": "A useful description of the resource.",
  • "description_detail": "# zeek_dce_rpc_potential_petit_potam_efs_rpc_call\\n\\n## Rationale\\n\\nPetitPotam is an attack frequently observed by security operations centers, often following phishing campaigns or targeting compromised users. These attacks typically focus on publicly exposed web servers that have not been patched. Additionally, PetitPotam can also be triggered by malicious files downloaded through phishing attempts.\\n\\nThe attack is particularly dangerous because it doesn’t require extensive reconnaissance of the target and can be executed remotely.\\n\\n## How it works\\n\\nThis rule operates by searching for operations that begin with 'efs' indicating use of EFS DRC functions\\n\\nThis rule operates by searching for operations that begin with 'efs' indicating use of EFS DRC functions.",
  • "groups": [
    ],
  • "id": "12345678-1234-1234-1234-123456789012",
  • "in_use": true,
  • "name": "My Resource",
  • "rules": [
    ],
  • "tags": [
    ],
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

importUseCase security

Import the rules from a use case.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the use case

query Parameters
enabled
boolean
Example: enabled=true

Should the rule be enabled immediately?

Responses

semantic-editor

A service to support editing the semantic layer datasources/datasets and their mappings.

applyChangeset semantic-editor

Applies a given changeset to update the semantic layer.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
required
object (SemanticChangeset)

Represents a series of changes to be applied to the semantic layer.

msg
required
string [ 1 .. 72 ] characters

Commit message for the changeset

Responses

Request samples

Content type
application/json
{
  • "changeset": {
    },
  • "msg": "Updated semantic mappings for firewalls"
}

Response samples

Content type
application/json
{
  • "validation_errors": [
    ]
}

validateChangeset semantic-editor

Validates a given changeset without applying it.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
required
object (SemanticChangeset)

Represents a series of changes to be applied to the semantic layer.

Responses

Request samples

Content type
application/json
{
  • "changeset": {
    }
}

Response samples

Content type
application/json
{
  • "validation_errors": [
    ]
}

exportYAML semantic-editor 

        Exports the following models to a zip of yaml files:
        - DatasourceTemplate,
        - DatasetTemplate
        - DatasetTemplateSchema
        - SemanticDatasource
        - SemanticDataset
        - DatasetMapping
        - SemanticMapping
Authorizations:
jwt_header_Authorization

Responses

settings

Provides access to user and platform settings.

listSettingsBuild settings

List all components and their build status.

Authorizations:
jwt_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

listConnections settings

List all external connections.

Authorizations:
jwt_header_Authorization
query Parameters
relations
Array of strings
Items Value: "SemanticDatasets"
Example: relations=SemanticDatasets

Relations to include in results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

setConnectionSemanticDatasets settings

Set the semantic datasets exposed to a connection.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the connection to update

Request Body schema: application/json
required
semantic_dataset_ids
Array of strings <uuid> [ items <uuid > ]

IDs of the semantic datasets to expose to the connection

Responses

Request samples

Content type
application/json
{
  • "semantic_dataset_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "client_id": "ccaa610a-7c3d-4b0d-a1c4-5526685326a8",
  • "client_secret_name": "my-secret-name",
  • "client_type": "databricks",
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "databricks_cluster_name": "my-cluster",
  • "databricks_id": "6824847051312641",
  • "databricks_instance": "adb-1234567890123456.7.azuredatabricks.net",
  • "databricks_warehouse_id": "6b9aa18440f1f4ef",
  • "description": "A useful description of the resource.",
  • "expiry": "2024-12-31T23:59:59Z",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "semantic_datasets": [
    ],
  • "tenant_id": "ee9f69dc-8f00-4cce-82c1-7c1cc8749131",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

pullConnectionSecret settings

Get the secret for a given connection. This will remove the existing secret if it exists and create a new one. This cannot be retrieved again later.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the external connection

Responses

Response samples

Content type
application/json
{
  • "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

getDbxJobStatuses settings

List the status of platform databricks jobs.

Authorizations:
jwt_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getOutputDestinations settings

List all output destinations.

Authorizations:
jwt_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createOutputDestination settings

Create a new output destination.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
required
object (OutputDestinationConfig3)
name
required
string [ 3 .. 255 ] characters

The name of the resource.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

updateOutputDestination settings

Update an existing output destination.

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
required
object (OutputDestinationConfig5)
id
required
string <uuid>

The unique identifier for the resource.

name
required
string [ 3 .. 255 ] characters

The name of the resource.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource"
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "created_at": "2023-03-14T16:34:00.000Z",
  • "id": "12345678-1234-1234-1234-123456789012",
  • "name": "My Resource",
  • "updated_at": "2023-03-14T16:34:00.000Z"
}

deleteOutputDestination settings

Delete an output destination configuration.

Authorizations:
jwt_header_Authorization
path Parameters
id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

ID of the output destination configuration to delete

Responses

ziggy

A service for interacting with Ziggy. An LLM powered virtual data engineer.

readConversations ziggy

Retrieve conversations, including their turns

Authorizations:
jwt_header_Authorization
query Parameters
skip
integer <int64> >= 0
Default: 0
Example: skip=0

The number of conversations to skip

limit
integer <int64> [ 1 .. 100 ]
Default: 100
Example: limit=100

The number of conversations to return

Responses

Response samples

Content type
application/json
{
  • "count": 3333315078046863000,
  • "data": [
    ]
}

upsertConversationWithTurn ziggy

Create a conversation with an initial turn or add a turn to existing conversation

Authorizations:
jwt_header_Authorization
Request Body schema: application/json
required
object

The conversation to create or update

required
object

The turn to add to the conversation

Responses

Request samples

Content type
application/json
{
  • "conversation_in": {
    },
  • "turn_in": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2021-08-01T12:00:00Z",
  • "id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "job": {
    },
  • "owner": {
    },
  • "owner_id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "title": "Data Source Questions",
  • "turns": [
    ],
  • "updated_at": "2021-08-01T12:00:00Z"
}

deleteConversation ziggy

Delete a single conversation by ID

Authorizations:
jwt_header_Authorization
path Parameters
conversation_id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

The ID of the conversation to delete

Responses

readConversation ziggy

Retrieve a single conversation by ID

Authorizations:
jwt_header_Authorization
path Parameters
conversation_id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

The ID of the conversation to retrieve

Responses

Response samples

Content type
application/json
{
  • "created_at": "2021-08-01T12:00:00Z",
  • "id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "owner": {
    },
  • "owner_id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "title": "Data Source Questions",
  • "turns": [
    ],
  • "updated_at": "2021-08-01T12:00:00Z"
}

getJobStatus ziggy

Get the status of a background job

Authorizations:
jwt_header_Authorization
path Parameters
job_id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

The ID of the job to retrieve

Responses

Response samples

Content type
application/json
{
  • "error": "Itaque numquam eos aut.",
  • "id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "status": "queued"
}

rateTurn ziggy

Rate a turn with thumbs up or down. Clicking the same rating again removes it.

Behavior: - If the same rating is applied again, it is removed (toggle off). - If a turn is upvoted, its query is cached. - If a turn is downvoted, any existing cached query is deleted. - If an upvote is removed, the cached query is also deleted.

Parameters: - turn_id: The ID of the turn to rate - rating: Either 'up' or 'down'

Returns: The updated turn object

Authorizations:
jwt_header_Authorization
path Parameters
turn_id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

The ID of the turn to retry

query Parameters
rating
string
Enum: "up" "down"
Example: rating=up

The rating to apply to the turn

Responses

Response samples

Content type
application/json
{
  • "aggregate_usage": {
    },
  • "author": "user",
  • "completions": [
    ],
  • "content": "Ipsum reiciendis aut nemo magni culpa.",
  • "created_at": "2021-08-01T12:00:00Z",
  • "error_message": "Ea fugiat.",
  • "id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "rating": "up",
  • "status": "Iure dolore molestiae.",
  • "updated_at": "2021-08-01T12:00:00Z"
}

retryTurn ziggy

Retry processing a failed AI turn

Authorizations:
jwt_header_Authorization
path Parameters
turn_id
required
string <uuid>
Example: 1b8f1b48-1f69-4d9b-8af4-ea3be290fc45

The ID of the turn to retry

Responses

Response samples

Content type
application/json
{
  • "aggregate_usage": {
    },
  • "author": "user",
  • "completions": [
    ],
  • "content": "Id in dolorum animi.",
  • "created_at": "2021-08-01T12:00:00Z",
  • "error_message": "Aut aut eos ea libero incidunt.",
  • "id": "1b8f1b48-1f69-4d9b-8af4-ea3be290fc45",
  • "job": {
    },
  • "rating": "up",
  • "status": "Velit aut dolorem accusantium laboriosam omnis.",
  • "updated_at": "2021-08-01T12:00:00Z"
}