Hanzo AIDocs
Sign inAPI key

Create roles — POST /v1/o11y/roles

Creates a custom role in the caller's org from a name, an optional description and the transaction groups it grants, answering the new role's id.

POST /v1/o11y/roles

O11y → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/o11y/roles
MethodPOST
OperationCreateRole
AuthAuthorization: Bearer $HANZO_API_KEY

Creates a custom role in the caller's org from a name, an optional description and the transaction groups it grants, answering the new role's id.

Names are lowercase letters and hyphens only, and may not start with the reserved managed-role prefix; the runtime refuses anything else.

Request

9 fields, body application/json (required).

FieldInTypeRequiredDescription
descriptionbodystring—Description says what the role is for.
namebodystring—Name is the role's name: lowercase letters and hyphens, at most 50 characters, not starting with the reserved managed-role prefix.
transactionGroupsbodyo11y.O11yTransactionGroup[]—TransactionGroups are the grants the role carries.
transactionGroups[].objectGroupbodyo11y.O11yObjectGroup—
transactionGroups[].objectGroup.resourcebodyo11y.O11yResourceRef—
transactionGroups[].objectGroup.resource.kindbodystring—Kind is the resource kind the type belongs to.
transactionGroups[].objectGroup.resource.typebodystring—Type is the resource type, e.g. role, dashboard, serviceaccount.
transactionGroups[].objectGroup.selectorsbodystring[]—Selectors pick the instances; a wildcard selects them all.
transactionGroups[].relationbodystring—Relation is the verb the grant allows.

Response

StatusBodyMeaning
201o11y.O11yRoleCreateOutcreated
202Approvalheld for approval
defaultproblem-detailsrefused

201 body — 3 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yCreated—
data.idbodystring—ID is the new record's id.
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y roles create
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.createRole({ description: "<description>", name: "<name>" });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).create_role(description="<description>", name="<name>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.CreateRole(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::create_role(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).createRole();
curl -X POST https://api.hanzo.ai/v1/o11y/roles \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "description": "<description>",
       "name": "<name>"
     }'

MCP reaches o11y through the o11y tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?
PreviousCreate publicNextCreate route policies