Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

TrustLogix API Documentation

This document describes the REST API endpoints available in the "Api Documentation" collection.

API Endpoints

api/account

Manages account information.

POST

/api/account/migrate_access_policies

Description: Migrates a policy from one TLX account to another based on a list of object names or policy names.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

{
  "migrateAccountId": "string",
  "sourceAccountId": "string",
  "sourceAccountObjects": [
    "string",
    "string"
  ],
  "sourceAccountPolicyNames": [
    "string",
    "string"
  ]
}

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The policy was migrated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Migrates a policy from one TLX account to another based on a list of policy names and versions.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The policy was promoted.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves account statistics.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of account statistics.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Lists all accounts with optional filtering and pagination.

Parameters:

  • accessPolicyStatus (string, optional): Filter by access policy status.

  • dataRiskCategory (string, optional): Filter by data risk category.

  • dataSeverity (string, optional): Filter by data severity.

  • dataSourceName (string, optional): Filter by data source name.

  • dataSourceType (string, optional): Filter by data source type.

  • includeAll (boolean, optional, default: false): Include all accounts.

  • includePolicyCount (boolean, optional, default: false): Include the count of policies.

  • monitoringPolicyStatus (string, optional): Filter by monitoring policy status.

  • page_no (integer, optional, default: 1): Page number for pagination.

  • page_size (integer, optional, default: 20): Number of items per page.

  • sort_by (string, optional, default: lastModifiedDate): Field to sort by.

  • sort_order (string, optional, default: DESC): Sort order (ASC or DESC).

  • status (string, optional): Filter by account status.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A paginated list of accounts.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: No accounts found matching the criteria.

GET

Description: Retrieves a single account record by its ID.

Parameters:

  • accountId (string, required): The ID of the account to retrieve.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The requested account record.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

Access Policies

listAccessPolicies

Retrieves a list of access policies for a given account.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies?page_no=1&page_size=20&sort_by=lastModifiedDate&sort_order=DESC

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Query Parameters:

    • page_no (integer): Page number for pagination.

    • page_size (integer): Number of items per page.

    • sort_by (string): Field to sort by.

    • sort_order (string): Sort order.

    • ... (other optional filters)

  • Example Response (200 OK): JSON

createAccessPolicy

Creates a new access policy.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies

  • Method: POST

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Example Request Body: JSON

Example Response (200 OK): JSON

getAccessPolicy

Retrieves a specific access policy by its ID.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the access policy.

  • Example Response (200 OK): JSON

updateAccessPolicy

Updates an existing access policy by its ID.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id

  • Method: PUT

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the access policy.

  • Example Request Body: (Same as createAccessPolicy)

  • Example Response (201 Created): JSON

deleteAccessPolicy

Deletes a specific access policy by its ID.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id?consent=false&includeViewAccessGrants=false

  • Method: DELETE

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the access policy.

  • Query Parameters:

    • consent (boolean): Confirmation for deletion.

    • includeViewAccessGrants (boolean): Deletes associated view grants.

  • Example Response (200 OK): JSON

disableAccessPolicy

Disables a specific access policy by its ID.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id/disable?consent=false&includeViewAccessGrants=false

  • Method: DELETE

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the access policy.

  • Query Parameters:

    • consent (boolean): Confirmation for disabling.

    • includeViewAccessGrants (boolean): Disables associated view grants.

  • Example Response (200 OK): JSON

getAccessPolicyByPolicyName

Retrieves a specific access policy by its name.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/name/:policyName

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • policyName (string, required): The name of the access policy.

  • Example Response (200 OK): JSON

getImpactedObject

Retrieves a list of objects impacted by an access policy.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/impacted_objects?policyId=string

  • Method: POST

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Query Parameters:

    • policyId (string): The ID of the policy to check for impacted objects.

  • Example Request Body: (Same as createAccessPolicy)

  • Example Response (200 OK): JSON

publishedPolicyList

Lists published policies.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/published_policy?limit=5

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Query Parameters:

    • limit (integer): The maximum number of policies to return.

  • Example Response (200 OK): JSON

getReviewAndPublishablePolicies

Retrieves policies that are ready for review and publishing.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/review_publish_policies

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Example Response (200 OK): JSON

publishPolicy

Publishes a policy.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id/publish_policy?includeViewAccessGrants=false

  • Method: POST

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the policy to publish.

  • Query Parameters:

    • includeViewAccessGrants (boolean): Includes associated view access grants.

  • Example Request Body: JSON

  • Example Response (200 OK): JSON

reviewPublishPolicy

Reviews and publishes a policy.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id/review_publish_policy?includeViewAccessGrants=false

  • Method: POST

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the policy to review and publish.

  • Query Parameters:

    • includeViewAccessGrants (boolean): Includes associated view access grants.

  • Example Response (200 OK): JSON

getAccessPolicyHistory

Retrieves the history of a specific access policy.

  • URL: {{baseUrl}}/api/account/:accountId/access_policies/:id/view_history?policy_status=string

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the access policy.

  • Query Parameters:

    • policy_status (string): Filters the history by policy status.

  • Example Response (200 OK): JSON

accountHealthStatus

Retrieves the health status of an account.

  • URL: {{baseUrl}}/api/account/:accountId/health

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Headers:

    • tenantId (string, required): The ID of the tenant.

  • Example Response (200 OK): JSON

getRoleTemplates

Retrieves role templates associated with an account.

  • URL: {{baseUrl}}/api/account/:accountId/role_templates?dataAccessPolicyId=string

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

  • Query Parameters:

    • dataAccessPolicyId (string): Filters role templates by a specific data access policy ID.

  • Headers:

    • tenantId (string, required): The ID of the tenant.

  • Example Response (200 OK): JSON

getUserAttributeValuesHistory

Retrieves the history of user entitlement attribute values.

  • URL: {{baseUrl}}/api/account/:accountId/user_entitlement_attribute/:id/view_history

  • Method: GET

  • Path Parameters:

    • accountId (string, required): The ID of the account.

    • id (string, required): The ID of the user entitlement attribute.

  • Example Response (200 OK): JSON

api/account_tag

Manages account tags and their associations.

PUT

Description: Deletes a data source tag.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: PUT

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The tag was deleted.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PUT

Description: Deletes records matching a combination of filters.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: PUT

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The tag association was deleted.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Get tag association object type names based on the user and tag key name.

Parameters:

  • accountId (string, required): The ID of the account.

  • tagKey (string, optional): The name of the tag key.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of object types.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Creates a new tag association.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: POST

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The tag association was created.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves tag association metadata.

Parameters:

  • accountId (string, required): The ID of the account.

  • columnNames (array of strings, optional): Filter by column names.

  • objectDatabases (array of strings, optional): Filter by object databases.

  • objectNames (array of strings, optional): Filter by object names.

  • objectSchemas (array of strings, optional): Filter by object schemas.

  • objectTypes (string, optional, default: TABLE): Filter by object types.

  • tagDatabases (array of strings, optional): Filter by tag databases.

  • tagKeys (array of strings, optional): Filter by tag keys.

  • tagSchemas (array of strings, optional): Filter by tag schemas.

  • type (string, required, default: TAG_VALUE): The type of metadata to retrieve.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of tag association metadata.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves tag references for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of tag references.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves data source tag references with pagination and filtering.

Parameters:

  • accountId (string, required): The ID of the account.

  • objectDatabases (array of strings, optional): Filter by object databases.

  • objectNames (array of strings, optional): Filter by object names.

  • objectSchemas (array of strings, optional): Filter by object schemas.

  • objectTypes (array of strings, optional): Filter by object types.

  • page_no (integer, optional, default: 1): Page number for pagination.

  • page_size (integer, optional, default: 10): Number of items per page.

  • sort_by (string, optional): Field to sort by.

  • sort_order (string, optional): Sort order (ASC or DESC).

  • tagDatabases (array of strings, optional): Filter by tag databases.

  • tagKeys (array of strings, optional): Filter by tag keys.

  • tagSchemas (array of strings, optional): Filter by tag schemas.

  • tagValues (array of strings, optional): Filter by tag values.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A paginated list of data source tag references.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: No tag references found matching the criteria.

GET

Description: Retrieves a list of data source tags with pagination and filtering.

Parameters:

  • accountId (string, required): The ID of the account.

  • page_no (integer, optional, default: 1): Page number for pagination.

  • page_size (integer, optional, default: 10): Number of items per page.

  • sort_by (string, optional): Field to sort by.

  • sort_order (string, optional): Sort order (ASC or DESC).

  • tagDatabases (array of strings, optional): Filter by tag databases.

  • tagNames (array of strings, optional): Filter by tag names.

  • tagSchemas (array of strings, optional): Filter by tag schemas.

  • tagValues (array of strings, optional): Filter by tag values.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A paginated list of data source tags.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: No tags found matching the criteria.

POST

Description: Creates new data source tags.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: POST

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The tags were created.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PUT

Description: Updates existing data source tags.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: PUT

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The tags were updated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves tag metadata.

Parameters:

  • accountId (string, required): The ID of the account.

  • tagDatabaseName (string, optional): Filter by tag database name.

  • tagKeyName (string, optional): Filter by tag key name.

  • tagSchemaName (string, optional): Filter by tag schema name.

  • type (string, required, default: TAG_VALUE): The type of metadata to retrieve.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of tag metadata.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Filters tag metadata.

Parameters:

  • accountId (string, required): The ID of the account.

  • tagDatabases (array of strings, optional): Filter by tag databases.

  • tagNames (array of strings, optional): Filter by tag names.

  • tagSchemas (array of strings, optional): Filter by tag schemas.

  • type (string, required, default: TAG_VALUE): The type of metadata to filter.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of filtered tag metadata.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: No metadata found matching the criteria.

POST

Description: Validates data source tags.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: POST

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful validation.

    • Body: JSON

  • 201 Created: The tags were validated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/authorized_system_entities

Manages authorized system entities.

GET

Description: Lists authorized entity groups for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of authorized entity groups.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Lists all authorized system entities for a given cloud account.

Parameters:

  • cloudAccountId (string, required): The ID of the cloud account.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of authorized system entities.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Creates new authorized system entities.

Request:

  • Method: POST

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: A list of created authorized system entities.

    • Body: JSON

  • 201 Created: The entities were created.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/authorized_system_entity

Manages a specific authorized system entity.

PUT

Description: Updates an authorized system IP record.

Parameters:

  • id (string, required): The ID of the record to update.

Request:

  • Method: PUT

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The updated authorized system entity record.

    • Body: JSON

  • 201 Created: The record was updated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

DELETE

Description: Deletes an authorized system user record by ID.

Parameters:

  • id (string, required): The ID of the record to delete.

  • type (string, required): The type of the system entity.

Request:

  • Method: DELETE

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The deleted authorized system user record.

    • Body: JSON

  • 204 No Content: The operation was successful, but there is no response body.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

api/authorized_user_app_mapping

Manages authorized user application mappings.

DELETE

Description: Deletes records matching any combination of filters.

Parameters:

  • accountId (string, required): The ID of the account.

  • allowedIp (string, optional): The allowed IP address.

  • appName (string, optional): The name of the application.

  • dbType (string, optional): The database type.

  • description (string, optional): The description of the mapping.

  • serviceUserName (string, optional): The service user name.

Request:

  • Method: DELETE

  • Headers:

    • accountId: <string> (required)

    • tenantId: <string> (required)

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates a successful deletion.

  • 204 No Content: The operation was successful, but there is no response body.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

DELETE

Description: Deletes a record by composite primary key.

Parameters:

  • accountId (string, required): The ID of the account.

  • appName (string, required): The name of the application.

  • serviceUserName (string, required): The service user name.

  • tenantId (string, required): The ID of the tenant.

Request:

  • Method: DELETE

  • Headers:

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates a successful deletion.

  • 204 No Content: The operation was successful, but there is no response body.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

GET

Description: Returns records matching any combination of filters.

Parameters:

  • accountId (string, required): The ID of the account.

  • allowedIp (string, optional): The allowed IP address.

  • appName (string, optional): The name of the application.

  • dbType (string, optional): The database type.

  • description (string, optional): The description of the mapping.

  • serviceUserName (string, optional): The service user name.

Request:

  • Method: GET

  • Headers:

    • accountId: <string> (required)

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of filtered authorized app access records.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: No records found matching the criteria.

GET

Description: Returns all authorized app access records.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of authorized app access records.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Creates a new authorized app access record.

Parameters:

  • accountId (string, required): The ID of the account.

  • tenantId (string, required): The ID of the tenant.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The created authorized app access record.

    • Body: JSON

  • 201 Created: The record was created.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/health

Performs a health check of the API.

GET

Description: Checks the health of the API.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates the API is healthy.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/login

Handles user login.

POST

Description: Performs user login with credentials and an optional user type.

Parameters:

  • userType (string, optional): The type of the user.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful login.

    • Body: JSON

  • 201 Created: The login was successful.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/logout

Handles user logout.

POST

Description: Logs out the current user.

Request:

  • Method: POST

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates a successful logout.

    • Body: JSON

  • 201 Created: The user was logged out.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/metadata

Retrieves metadata information.

GET

Description: Retrieves data domains for the tenant.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of data domains.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves display data types.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of display data types.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves application roles for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • applicationNames (array of strings, required): Filter by application names.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of application roles.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves applications for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of applications.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves column values for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • columnName (string, required): The name of the column.

  • workspace (string, optional): The workspace name.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of column values.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves columns for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • databaseName (string, optional): The name of the database.

  • isDataAttribute (boolean, optional, default: false): Filter for data attributes.

  • schemaName (string, optional): The name of the schema.

  • tableNames (string, required): A comma-separated list of table names.

  • workspace (string, optional): The workspace name.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of columns.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves data product tags for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of data product tags.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves databases for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • domain (string, optional): Filter by domain.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of databases.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves descriptions of functions for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • functionName (string, required): The name of the function.

  • workspace (string, optional): The workspace name.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A function description.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves functions for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • databaseNames (string, optional): Filter by database names.

  • isMultiObject (string, optional): Filter by whether the function supports multiple objects.

  • schemaNames (string, optional): Filter by schema names.

  • type (string, optional, default: NONE): Filter by function type.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of functions.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves principals for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • databaseNames (array of strings, optional): Filter by database names.

  • includeDatabaseRoles (boolean, optional, default: true): Include database roles in the results.

  • includeSystemRoles (boolean, optional, default: false): Include system roles in the results.

  • tagNames (array of strings, optional): Filter by tag names.

  • type (string, required, default: SERVICE_PRINCIPAL): The type of principals to retrieve.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of principals.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves principals with their types for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • databaseNames (array of strings, optional): Filter by database names.

  • includeDatabaseRoles (boolean, optional, default: true): Include database roles in the results.

  • includeSystemRoles (boolean, optional, default: false): Include system roles in the results.

  • tagNames (array of strings, optional): Filter by tag names.

  • type (string, required, default: SERVICE_PRINCIPAL): The type of principals to retrieve.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of principals with their types.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves schemas for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • databaseNames (string, required): A comma-separated list of database names.

  • domain (string, optional): Filter by domain.

  • enableAllSchemas (boolean, optional, default: false): Include all schemas.

  • isMultiDb (boolean, optional, default: false): Indicate if multiple databases are being queried.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of schemas.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves security role information for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • schemaNames (string, required): A comma-separated list of schema names.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of security role information.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves outbound shares for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • databaseName (string, optional): The name of the database.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of outbound shares.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves table relationships for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • schemaNames (string, required): A comma-separated list of schema names.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of table relationships.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves tables for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • database (string, optional): The name of the database.

  • domain (string, optional): The domain name.

  • objectType (string, optional, default: VIEW): The type of the object.

  • schemaNames (string, optional): A comma-separated list of schema names.

  • search (string, optional): Search for tables by name.

  • workspace (string, optional): The workspace name.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of tables.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves tags for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • domain (string, optional, default: COLUMN): Filter by domain.

  • includeTagValue (boolean, optional, default: true): Include tag values in the results.

  • includeUnclassifiedTag (boolean, optional, default: false): Include unclassified tags.

  • policyTypeId (string, optional): Filter by policy type ID.

  • tagNames (string, optional): Filter by tag names.

  • workspace (string, optional): Filter by workspace.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of tags.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves workspaces for a given account.

Parameters:

  • accountId (string, required): The ID of the account.

  • registered (boolean, optional, default: false): Filter for registered workspaces.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of workspaces.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/monitoring_policies

Manages monitoring policies.

PUT

Description: Enables or disables a monitoring policy.

Parameters:

  • id (string, required): The ID of the policy to activate/deactivate.

  • status (boolean, required): The new status of the policy (true for active, false for inactive).

Request:

  • Method: PUT

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates a successful operation.

    • Body: JSON

  • 201 Created: The policy was enabled/disabled.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves a single monitoring policy record by its ID.

Parameters:

  • id (string, required): The ID of the policy to retrieve.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The requested monitoring policy record.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

DELETE

Description: Deletes a monitoring policy by ID.

Parameters:

  • id (string, required): The ID of the policy to delete.

Request:

  • Method: DELETE

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates a successful deletion.

    • Body: JSON

  • 204 No Content: The operation was successful, but there is no response body.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

POST

Description: Creates a new monitoring policy.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The created monitoring policy.

    • Body: JSON

  • 201 Created: The policy was created.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PUT

Description: Updates an existing monitoring policy.

Parameters:

  • id (string, required): The ID of the policy to update.

Request:

  • Method: PUT

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The updated monitoring policy.

    • Body: JSON

  • 201 Created: The policy was updated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/user

Manages user information.

GET

Description: Lists all users for a given tenant.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of users.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/userInfo

Retrieves user information.

GET

Description: Retrieves information about the currently logged-in user.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The user's information.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/user_attribute_configuration

Manages user attribute configurations.

POST

Description: Imports user attributes from an external source.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: /

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful import.

    • Body: JSON

  • 201 Created: The attributes were imported.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves a list of user attribute sources.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of user attribute sources.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves user attributes from an external source.

Parameters:

  • id (string, required): The ID of the user attribute configuration.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of user attributes.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Imports users and their attributes from an external source to a data source.

Parameters:

  • id (string, required): The ID of the user attribute configuration.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: /

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful import.

    • Body: JSON

  • 201 Created: The users were imported.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Retrieves users from an external source.

Parameters:

  • id (string, required): The ID of the user attribute configuration.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: A list of users from the external source.

    • Body: JSON

  • 201 Created: The users were retrieved.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

GET

Description: Retrieves a user attribute configuration by ID.

Parameters:

  • id (string, required): The ID of the user attribute configuration.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The user attribute configuration.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PUT

Description: Updates a user attribute configuration.

Parameters:

  • id (string, required): The ID of the user attribute configuration to update.

Request:

  • Method: PUT

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful update.

    • Body: JSON

  • 201 Created: The configuration was updated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

DELETE

Description: Deletes a user attribute configuration by ID.

Parameters:

  • id (string, required): The ID of the user attribute configuration to delete.

Request:

  • Method: DELETE

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: Indicates a successful deletion.

    • Body: JSON

  • 204 No Content: The operation was successful, but there is no response body.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

GET

Description: Retrieves user attribute configurations with optional account ID.

Parameters:

  • accountId (string, optional): The ID of the account.

Request:

  • Method: GET

  • Headers:

    • tenantId: <string> (required)

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of user attribute configurations.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Saves a new user attribute configuration.

Request:

  • Method: POST

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: Indicates a successful save.

    • Body: JSON

  • 201 Created: The configuration was saved.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PUT

Description: Updates a user attribute configuration.

Parameters:

  • accountId (string, required): The ID of the account.

  • tableId (string, optional): The ID of the table.

Request:

  • Method: PUT

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The updated user attributes metadata.

    • Body: JSON

  • 201 Created: The configuration was updated.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PATCH

Description: Updates details of a user attributes table metadata.

Parameters:

  • accountId (string, required): The ID of the account.

  • id (string, required): The ID of the user attributes table metadata.

Request:

  • Method: PATCH

  • Headers:

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The updated user attributes table metadata.

    • Body: JSON

  • 204 No Content: The operation was successful, but there is no response body.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/user_attribute_configuration_type

Retrieves user attribute configuration types.

GET

Description: Retrieves a user attribute configuration type by ID.

Parameters:

  • id (string, required): The ID of the user attribute configuration type.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The user attribute configuration type.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/user_attribute_configuration_type_by_source_type

Retrieves user attribute configuration types by source type.

GET

Description: Retrieves a user attribute configuration type by source type.

Parameters:

  • sourceType (string, required): The source type of the user attribute configuration.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The user attribute configuration type.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/user_attribute_value

Manages user attribute values.

GET

Description: Retrieves a list of user attribute values.

Parameters:

  • accountId (string, required): The ID of the account.

  • attributeName (string, required): The name of the attribute.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A list of user attribute values.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Exports user attributes.

Request:

  • Method: POST

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: application/json

    • Accept: application/json

    • Authorization: <API Key>

  • Body: JSON

Responses:

  • 200 OK: The exported data.

    • Body: string

  • 201 Created: The export was successful.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

POST

Description: Imports user attributes from a CSV file.

Request:

  • Method: POST

  • Headers:

    • tenantId: <string> (required)

    • Content-Type: multipart/form-data

    • Accept: application/json

    • Authorization: <API Key>

  • Body:

    • accountId (string): The ID of the account.

    • file (file): The CSV file to import.

Responses:

  • 200 OK: Indicates a successful import.

    • Body: JSON

  • 201 Created: The import was successful.

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

api/v2/monitoring_policies

Manages monitoring policies with advanced filtering.

GET

Description: Retrieves a list of monitoring policies with pagination and filtering.

Parameters:

  • accountId (string, required): The ID of the account.

  • complianceTags (array of strings, optional): Filter by compliance tags.

  • page_no (integer, optional, default: 1): Page number for pagination.

  • page_size (integer, optional, default: 20): Number of items per page.

  • policyName (array of strings, optional): Filter by policy names.

  • riskCategory (array of strings, optional): Filter by risk categories.

  • riskCount (string, optional): Filter by risk count.

  • severity (array of strings, optional): Filter by severity levels.

  • sort_by (string, optional, default: lastModifiedDate): Field to sort by.

  • sort_order (string, optional, default: DESC): Sort order (ASC or DESC).

  • status (array of strings, optional): Filter by policy status.

  • workspace (array of strings, optional): Filter by workspaces.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: A paginated list of monitoring policies.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: No policies found matching the criteria.

api/v2/monitoring_policies/:id

Manages a specific monitoring policy with advanced features.

GET

Description: Retrieves a single monitoring policy record by its ID.

Parameters:

  • id (string, required): The ID of the policy to retrieve.

Request:

  • Method: GET

  • Headers:

    • Accept: application/json

    • Authorization: <API Key>

Responses:

  • 200 OK: The requested monitoring policy record.

    • Body: JSON

  • 401 Unauthorized: Authentication failed.

  • 403 Forbidden: Insufficient permissions.

  • 404 Not Found: The requested resource was not found.

PreviousJanuary 2025

Was this helpful?