wxctl resources for this build, so it always matches your binary.
Available on shows where each kind runs: Both (SaaS and Software), SaaS only, or Software only. For a kind’s fields, dependencies, and authoring rules, follow the reference link in each section or run wxctl explain <kind>.
AI Factsheets
factsheets · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
inventory | Both | /v1/aigov/inventories | An inventory is an AI Factsheets model inventory: a governance catalog that holds the model use cases tracked for an organization. |
model_entry | Both | /v1/aigov/model_inventory/model_entries | A model entry is an AI Factsheets model use case that groups the tracked models, deployments, and factsheets for one business problem within a model inventory. |
model_tracking | Both | /v1/aigov/model_inventory/models/{model}/model_entry | Associates a trained Watson Machine Learning model (incl. AutoAI) with a governance model_entry (AI use case) so the model is tracked in a model inventory. |
Cloud Object Storage
cloud_object_storage · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
adls_container | SaaS | /adls/{filesystem} | Azure Data Lake Storage container (Gen1 or Gen2). |
gcs_bucket | SaaS | /gcs/{name} | Google Cloud Storage bucket. |
s3_bucket | Both | /cos/{name} | S3-compatible bucket (IBM COS, AWS S3, MinIO, Ceph). |
s3_object | Both | /cos/{bucket}/{key} | An object inside an s3_bucket. |
storage_connection | Both | /local/storage_connections | Credential-holding kind for object-store / file-system backends. |
Data & AI Common Core
common_core · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
asset_promotion | Both | /v2/assets | Promotes a project-side asset, a native model the training job stored under a known name, into a deployment space. |
business_term | Both | /v3/glossary_terms | A Business Term is a glossary entry that defines standardized business vocabulary and semantics for data governance in Watsonx Data. |
business_terms | Both | /v3/glossary_terms | Business Terms provides bulk creation functionality for multiple business terms in a single API call. |
catalog | Both | /v2/catalogs?check_bucket_existence=false | A Catalog is a metadata repository that organizes and manages table schemas, partitions, and file locations for data lake operations in Watsonx Data. |
category | Both | /v3/categories | A Category is a hierarchical classification structure used to organize and group data assets, business terms, and other governance artifacts in Watsonx Data. |
common_core_connection | Both | /v2/connections | A Connection is a data source configuration that enables Watsonx Data to access external databases, object storage systems, and other data repositories. |
data_asset | Both | /v2/assets | A Data Asset uploads a local file such as a CSV into a space or project as a CAMS data asset and exposes its asset id for downstream consumers such as an AutoAI experiment’s training_data_references. |
environment | Both | /v2/environments | A notebook runtime environment in a watsonx.ai project. |
job | Both | /v2/jobs | A platform Job definition in a watsonx.ai project: a reusable run configuration binding a runnable asset (a script_asset or a notebook) to a runtime environment. |
job_run | Both | /v2/jobs/{job}/runs | A single execution of a platform job. |
package_extension | Both | /v2/package_extensions | A Package Extension defines additional Python packages to include in a software specification. |
project | Both | /transactional/v2/projects | A Project is a collaborative workspace that organizes assets, tools, notebooks, jobs, and data connections for data science and AI workflows. |
rule | Both | /v3/enforcement/rules | A Rule is an automated policy enforcement mechanism that implements data governance controls in Watsonx Data. |
rules | Both | /v3/enforcement/rules | Rules provides bulk creation functionality for multiple governance rules in a single API call. |
script_asset | Both | /v2/assets | A Script Asset uploads a local Python file into a watsonx.ai project (or space) as a CAMS asset of type script, exposing its asset id for a platform job to run. |
software_specification | Both | /v2/software_specifications | A Software Specification defines a runtime environment for deploying AI services and functions. |
space | Both | /v2/spaces | A Space is a deployment environment for promoting and managing machine learning models, functions, and other AI assets. |
IBM Concert
concert · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
concert_application | Software | /core/api/v1/applications | A Concert application is the top-level managed entity in IBM Concert’s inventory, the unit Concert tracks for risk posture, vulnerabilities, dependencies, and resilience. |
concert_automation_rule | Software | /core/api/v1/automation_rules | A Concert automation rule fires an action (e.g. auto-create an ITSM ticket) when a use-case condition is met, the declarative half of Concert’s auto-ticketing. |
concert_compliance_profile | Software | /compliance/api/v1/profiles | A Concert compliance profile is a named, versioned set of controls (drawn from a pre-imported compliance catalog) that Concert evaluates applications against to score compliance posture, the declarative half of Concert’s compliance / AI-governance surface (sovereign, CSCF/ISCF, etc.). |
concert_credential | Software | /core/api/v1/credentials | A Concert credential is a named key/value secret bundle used by ingestion jobs to authenticate against source systems. |
concert_environment | Software | /core/api/v1/environments | A Concert environment is a deployment target (e.g. a cluster, region, or stage) tracked in IBM Concert’s inventory. |
concert_ingestion_job | Software | /core/api/v1/ingestion_jobs | A Concert ingestion job pulls data from a source system (authenticating with a concert_credential) into IBM Concert’s inventory on a schedule. |
concert_resilience_input_data_key | Software | /resilience/assessment/api/v1/input_data_keys | A Concert resilience input-data key (InputDataKeyRequest) defines a named metric input, its label, units, and data type, that resilience requirements evaluate against. |
concert_resilience_library | Software | /resilience/assessment/api/v1/library | A Concert resilience library (LibraryRequest) groups resilience requirements into a reusable set. |
concert_resilience_posture | Software | /resilience/assessment/api/v1/posture | A Concert resilience assessment posture (GraderPostureRequest) binds a concert_resilience_profile to a target (application/deployment) and schedules its resilience assessment. |
concert_resilience_profile | Software | /resilience/assessment/api/v1/profile | A Concert resilience assessment profile (GraderProfileRequest) is a named set of resilience requirements, scored against metric input-data keys, that Concert evaluates to rate an application’s resilience posture. |
concert_source_repo | Software | /core/api/v1/source_repos | A Concert source repository is a version-controlled code repo tracked in IBM Concert’s inventory for SBOM, CVE, and dependency posture. |
IBM Concert Workflows
concert_workflows · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
concert_worker_group | Software | /v1/worker-group | A Concert Workflows (Pliant) worker group, a named pool that flow runs and schedules execute on. |
concert_workflow | Software | /v1/flows/{user_name}/import | A Concert Workflows (Pliant) flow, imported from a local zip. |
concert_workflow_exposure | Software | /v1/flow-exposures/{user_name} | A Concert Workflows (Pliant) flow exposure, publishes a flow at an HTTP path so it can be triggered. |
concert_workflow_role | Software | /v1/flow-roles/ | A Concert Workflows (Pliant) flow role, a named grant bundling users, worker groups, and per-surface policies (flow, application, auth-storage, schedule, automation-panel). |
concert_workflow_schedule | Software | /v1/flowschedules/{user_name} | A schedule that runs a Concert Workflows (Pliant) flow on a cron cadence. |
IBM Instana
instana · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
instana_alert | Both | /api/events/settings/alerts/{id} | An Instana alerting configuration (AlertingConfiguration, /api/events/settings/alerts) routes events that match an event filter to one or more alerting channels, the only API mechanism for delivering custom-event notifications to an external channel. |
instana_alerting_channel | Both | /api/events/settings/alertingChannels | An Instana alerting channel (AbstractIntegration) is a notification target, email, Slack, generic webhook, PagerDuty, Opsgenie, Splunk, and more, that smart-alert configs route events to. |
instana_api_token | Both | /api/settings/api-tokens | An Instana API token (ApiToken) created via /api/settings/api-tokens; the identity is a CLIENT-SUPPLIED internalId (also the path param), the human identifier is name. |
instana_application_alert_config | Both | /api/events/settings/application-alert-configs | An Instana application smart alert (ApplicationAlertConfig) evaluates a rule (erroneous-call-rate, latency, throughput, …) over an application perspective’s calls and routes triggered events to alerting channels. |
instana_application_perspective | Both | /api/application-monitoring/settings/application | An Instana application perspective is a saved, filter-defined view of an application’s traces and calls, the top-level unit Instana groups service monitoring, smart alerts, and SLOs around. |
instana_automation_action | Both | /api/automation/actions | An Instana automation action (Action) is a runnable script/HTTP/etc. |
instana_automation_policy | Both | /api/automation/policies | An Instana automation policy (Policy) binds a trigger (a customEvent / builtinEvent / smart-alert type, referencing an event spec by id) to one or more type configurations that run automation actions or workflows. |
instana_builtin_event_spec | Both | /api/events/settings/event-specifications/built-in | An Instana BUILT-IN event specification (BuiltInEventSpecification) is a shipped, catalog-defined event rule. |
instana_custom_dashboard | Both | /api/custom-dashboard | An Instana custom dashboard (CustomDashboard) is a titled board of widgets with access rules. |
instana_custom_event_spec | Both | /api/events/settings/event-specifications/custom | An Instana custom event specification raises events (and optionally incidents, via triggering) when a rule over an entity type’s metrics matches, threshold breaches, entity verification, entity count, and the other AbstractRule variants. |
instana_custom_payload_configuration | Both | /api/events/settings/custom-payload-configurations | The Instana GLOBAL custom payload configuration (CustomPayloadConfiguration), a tenant-wide set of custom key/type fields attached to every triggered event. |
instana_infra_alert_config | Both | /api/events/settings/infra-alert-configs | An Instana infrastructure smart alert (InfraAlertConfig) evaluates a rule (entityType + metricName + aggregation, narrowed by a tag filter) over infrastructure entities and routes triggered events to alerting channels. |
instana_log_alert_config | Both | /api/events/settings/global-alert-configs/logs | An Instana log smart alert (LogAlertConfig) evaluates a rule over log events (narrowed by a tag filter) and routes triggered events to alerting channels. |
instana_maintenance_window | Both | /api/settings/v2/maintenance/{id} | An Instana maintenance window (MaintenanceConfigV2) suppresses alerting for the entities matched by its query during a scheduled window. |
instana_rbac_group | Both | /api/settings/rbac/groups | An Instana RBAC access group (ApiGroup) binds members to a permission set (ApiPermissionSet: a permissions string array plus optional scope filters). |
instana_rbac_team | Both | /api/settings/rbac/teams | An Instana RBAC team (ApiTeam) groups members under a scope for scoped access. |
instana_release | Both | /api/releases | An Instana release (Release) marks a deployment boundary on the timeline, optionally scoped to applications and services, so events and analytics can be correlated to a rollout. |
instana_slo_alert_config | Both | /api/events/settings/global-alert-configs/service-levels | An Instana SLO smart alert (ServiceLevelsAlertConfig) evaluates a rule (status / error-budget / burn-rate) over one or more SLO configs and routes triggered events to alerting channels. |
instana_slo_config | Both | /api/settings/slo | An Instana SLO config (SLOConfigWithRBACTag) defines a service-level objective: a target attainment over a time window for a chosen entity and indicator. |
instana_synthetic_alert_config | Both | /api/events/settings/global-alert-configs/synthetics | An Instana synthetic smart alert (SyntheticAlertConfig) evaluates a rule over one or more synthetic tests’ results and routes triggered events to alerting channels. |
instana_synthetic_test | Both | /api/synthetics/settings/tests | An Instana synthetic test (SyntheticTest) runs a scripted or HTTP probe from one or more PoP locations on a schedule. |
instana_website_alert_config | Both | /api/events/settings/website-alert-configs | An Instana website smart alert (WebsiteAlertConfig) evaluates a rule over an end-user-monitored website’s beacons and routes triggered events to alerting channels. |
instana_website_config | Both | /api/website-monitoring/config | An Instana website (End-User Monitoring config) is the top-level unit Instana groups browser/EUM beacons and website smart alerts around. |
IBM Planning Analytics
planning_analytics · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
pa_chore | Both | /Chores | A Planning Analytics (TM1 Database 12) chore, a schedule that runs an ordered list of tasks (each executing a process) at a start time and frequency. |
pa_cube | Both | /Cubes | A Planning Analytics (TM1 Database 12) cube, an N-dimensional data store defined over an ordered list of dimensions, with optional TM1 rules. |
pa_dimension | Both | /Dimensions | A Planning Analytics (TM1 Database 12) dimension, a named set of members organized into one or more hierarchies. |
pa_group | Both | /Groups | A Planning Analytics (TM1 Database 12) security group, a named role that users belong to and that cube/dimension security is granted against. |
pa_hierarchy | Both | /Dimensions('{dimension}')/Hierarchies | A hierarchy within a Planning Analytics (TM1 Database 12) dimension, a named tree of members (elements) and parent/child consolidations (edges). |
pa_process | Both | /Processes | A Planning Analytics (TM1 Database 12) TurboIntegrator process, the scripting unit (four procedure stages, a data source, typed parameters and source variables) created via the TM1 REST OData API (/Processes) and identified by its name (the OData entity key). |
pa_sql_data_source | Both | /SQLDataSources | A Planning Analytics (TM1 Database 12) named SQL data source, a reusable ODBC/SQL connection definition that TurboIntegrator processes read from. |
pa_subset | Both | /Dimensions('{dimension}')/Hierarchies('{hierarchy}')/Subsets | A named subset of a Planning Analytics (TM1 Database 12) hierarchy, either a static list of members (elements) or a dynamic MDX expression. |
pa_user | Both | /Users | A Planning Analytics (TM1 Database 12) user, a security principal with a password and a set of group memberships. |
pa_view | Both | /Cubes('{cube}')/Views | A Planning Analytics (TM1 Database 12) cube view, a saved query over a cube, either a native axis layout (columns/rows/titles) or an MDX view. |
IBM Planning Analytics Workspace
pa_workspace · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
paw_application | Both | /Assets | A Planning Analytics Workspace application (OData asset type application), an authored view / exploration document stored in the /pacontent/v1 Assets tree. |
paw_book | Both | /Assets | A Planning Analytics Workspace book (OData asset type dashboard), an authored view / exploration document stored in the /pacontent/v1 Assets tree. |
paw_folder | Both | /Assets | A Planning Analytics Workspace folder (OData asset type folder), an authored view / exploration document stored in the /pacontent/v1 Assets tree. |
paw_plan | Both | /Assets | A Planning Analytics Workspace plan (OData asset type plan), an authored planning process document stored in the /pacontent/v1 Assets tree. |
paw_view | Both | /Assets | A Planning Analytics Workspace view (OData asset type tm1view), an authored view document stored in the /pacontent/v1 Assets tree. |
paw_workbench | Both | /Assets | A Planning Analytics Workspace workbench (OData asset type workbench), an authored workbench document stored in the /pacontent/v1 Assets tree. |
OpenScale
openscale · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
data_mart | Both | /v2/data_marts | An OpenScale data mart is the per-instance datastore that holds monitoring records (payload, feedback, metrics) for every subscribed deployment. |
data_set | Both | /v2/data_sets | A data set is a typed store within an OpenScale data mart (payload logging, feedback, or business payload) that records the data used to compute a subscription’s monitor metrics. |
guardrails_policy | Both | /guardrails-manager/v1/policies | A guardrails policy defines content-filtering and safety rules (such as PII or HAP detection) that OpenScale enforces on generative-AI model inputs and outputs. |
integrated_system | Both | /v2/integrated_systems | An integrated system registers an external service (notifications, a custom metrics provider, or a third-party endpoint) that OpenScale calls during monitoring. |
monitor_definition | Both | /v2/monitor_definitions | A monitor definition registers a custom monitor type in OpenScale, declaring its metrics, thresholds, and tags. |
monitor_instance | Both | /v2/monitor_instances | A monitor instance activates a monitor (quality, fairness, drift, explainability, or a custom definition) on a subscription, with its parameters and alert thresholds. |
service_provider | Both | /v2/service_providers | A service provider binds a machine-learning serving environment (such as a watsonx.ai or WML space) to OpenScale so its deployments can be discovered and monitored. |
subscription | Both | /v2/subscriptions | A subscription connects one deployed model to OpenScale for monitoring, linking it to a service provider and data mart and capturing its input and output schema. |
vault
vault · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
vault_audit_device | Both | /v1/sys/audit/{path} | A HashiCorp Vault audit device (sys/audit/), enables audit logging of every request/response to a backend (type file writes to a log path). |
vault_auth_method | Both | /v1/sys/auth/{path} | A HashiCorp Vault auth method mount (sys/auth/), enabled with type jwt for IBM Verify / OIDC federation. |
vault_database_role | Both | /v1/{mount}/roles/{name} | A role on a Vault database secrets engine (/roles/), binds the SQL creation statements and lease TTLs Vault uses to mint dynamic database credentials. |
vault_group_alias | Both | /v1/identity/group-alias | A Vault group alias (identity/group-alias) that binds an external IdP group name to a Vault external identity group through an auth mount accessor. |
vault_identity_group | Both | /v1/identity/group | A Vault external identity group (identity/group) that maps an external IdP group (via a vault_group_alias) to Vault policies. |
vault_jwt_role | Both | /v1/auth/{backend}/role/{name} | A role on a Vault JWT auth backend (auth//role/), binds token audiences, the identity claim, and token policies for OIDC logins. |
vault_policy | Both | /v1/sys/policies/acl/{name} | A HashiCorp Vault ACL policy (sys/policies/acl/). |
vault_secret_engine | Both | /v1/sys/mounts/{path} | A HashiCorp Vault database secrets engine mount (sys/mounts/, type=database). |
watsonx Orchestrate
watsonx_orchestrate · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
agent | Both | /v1/orchestrate/agents | An Agent is a configurable AI assistant within Watsonx Orchestrate that can perform tasks using tools, collaborate with other agents, and leverage knowledge bases. |
agent_release | Both | /v1/orchestrate/agents/{agent_id}/releases | Deploys (releases) a watsonx Orchestrate agent’s current draft to the live environment. |
knowledge_base | Both | /v1/orchestrate/knowledge-bases/documents | A Knowledge Base provides document-based context and information retrieval capabilities for agents. |
model | Both | /v1/orchestrate/models | A Model Configuration defines custom language model settings and parameters for use within Watsonx Orchestrate. |
orchestrate_connection | Both | /v1/orchestrate/connections/applications | A Connection represents authentication credentials and configuration for integrating external applications with Watsonx Orchestrate. |
tool | Both | /v1/orchestrate/tools | A Tool is a specification for a callable function or service that agents can invoke to perform actions and retrieve information. |
toolkit | Both | /v1/orchestrate/toolkits | An MCP (Model Context Protocol) toolkit backed by a local or remote MCP server. |
watsonx.ai
watsonx_ai · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
ai_service | Both | /ml/v4/ai_services?version=2024-01-01 | An AI Service is a deployable code artifact for Watson Machine Learning. |
autoai_experiment | Both | /ml/v4/trainings?version=2024-01-01 | An AutoAI Experiment runs a watsonx.ai AutoAI training to completion and surfaces the ranked pipeline leaderboard. |
notebook | Both | /v2/assets | A Notebook asset stored in a watsonx.ai project. |
wml_deployment | Both | /ml/v4/deployments?version=2024-01-01 | A WML Deployment creates a live online endpoint from an AI service or model. |
wml_function | Both | /ml/v4/functions?version=2024-01-01 | A Python function asset stored in Watson Machine Learning. |
wml_model | Both | /ml/v4/models?version=2024-01-01 | A WML Model materializes the winning pipeline of a completed AutoAI experiment as a deployable wml-hybrid_0.1 model. |
wml_script | Both | /ml/v4/functions?version=2024-01-01 | A Python script asset stored in Watson Machine Learning. |
watsonx.data
watsonx_data · Full field reference →
| Kind | Available on | Endpoint | Description |
|---|---|---|---|
database_connection | Both | /local/database_connections | Credential-holding kind for external database connections consumed by database_registration. |
database_registration | Both | /v3/database_registrations | Registers an external database (Db2, PostgreSQL, MySQL, Kafka, etc.) with watsonx.data and atomically creates its associated catalog. |
db2_engine | Both | /v3/db2_engines | A Db2 Engine registers an external IBM Db2 instance as a federated query engine in watsonx.data. |
ingestion_job | Both | /v3/lhingestion/api/v1/ingestion/jobs | An Ingestion Job loads data from object storage (CSV, Parquet, JSON, ORC, Avro, or txt) into a watsonx.data lakehouse table. |
integration | Both | /v3/integrations | Registers an external governance / lineage service with watsonx.data, IBM Knowledge Catalog (ikc), Apache Ranger (ranger), Manta lineage (manta), or Databand (databand). |
milvus_service | Both | /v3/milvus_services | A Milvus Service is the managed Milvus vector store in watsonx.data, the vector backend for embeddings / similarity search (e.g. RAG knowledge bases). |
other_engine | Both | /v3/other_engines | An Other Engine registers a generic external query engine (anything not covered by the typed presto/spark/db2 kinds) with watsonx.data, identified by a display name plus a connection_string and an engine type. |
prestissimo_engine | Both | /v3/prestissimo_engines | A Prestissimo Engine is the C++ (Velox-backed) distributed SQL query engine in watsonx.data, the high-performance twin of the Java Presto engine. |
presto_engine | Both | /v3/presto_engines | A Presto Engine is a distributed SQL query engine in watsonx.data that runs analytical queries across lakehouse catalogs and object storage. |
sal_enrichment_job | Both | /v3/sal_integration/enrichment | Runs a Semantic Automation Layer (SAL) metadata-enrichment job over a catalog/schema’s tables. |
sal_enrichment_settings | Both | /v3/sal_integration/enrichment/project_settings | Per-project metadata-enrichment settings for the Semantic Automation Layer (SAL) on watsonx.data. |
sal_global_settings | Both | /v3/sal_integration/enrichment/global_settings | Global metadata-enrichment defaults for the Semantic Automation Layer (SAL) on watsonx.data. |
sal_glossary | Software | /v3/sal_integration/glossary/upload_processes | Uploads a business-glossary CSV into the watsonx.data Semantic Automation Layer (SAL) and polls the upload process to a terminal state, so a glossary can be uploaded before/around enrichment (richer term assignment). |
sal_integration | Both | /v3/sal_integration | Enables the Semantic Automation Layer (SAL) on watsonx.data, the metadata-enrichment / auto-cataloging integration that backs IKC governance. |
schema | Both | /v3/catalogs/{catalog_id}/schemas | A Schema is a logical grouping of tables within a watsonx.data catalog. |
spark_engine | Both | /v3/spark_engines | A Spark Engine is a serverless Apache Spark execution environment in watsonx.data used for data ingestion jobs, Spark SQL, and general Spark applications. |
storage_registration | Both | /v3/storage_registrations | Registers an object-store bucket with watsonx.data and atomically creates its associated lakehouse catalog (iceberg or hive). |
Listing kinds yourself
Runwxctl resources to print the same catalog from your own build, with filters:
Inspecting one kind
Usewxctl explain <kind> to see a kind’s fields, dependencies, endpoints, and authoring notes:
${kind.ref_name} references, the REST endpoints wxctl calls, and authoring rules for the YAML envelope.