API Explorer Examples

Default Explorer

The basic API Explorer without any pre-selection:

<ApiExplorer />

Select APIPlatformSource Code ManagementIdentity ManagementTicketingVulnerability ManagementCommunicationsEDR & XDRIncident ManagementPackage & Container RegistryObservabilityPublic Cloud (Infra)

Select an API first

Authorization

API Key *

You can find or generate your API key in the Unizo Console

---

Pre-selected Category

Pre-select the Source Code Management category:

<ApiExplorer defaultCategory="scm" />

Select APIPlatformSource Code ManagementIdentity ManagementTicketingVulnerability ManagementCommunicationsEDR & XDRIncident ManagementPackage & Container RegistryObservabilityPublic Cloud (Infra)

Select an API first

Authorization

API Key *

You can find or generate your API key in the Unizo Console

---

Pre-selected Category and Endpoint

Pre-select both category and a specific endpoint:

<ApiExplorer 
  defaultCategory="identity" 
  defaultEndpoint="GET List Users" 
/>

Select APIPlatformSource Code ManagementIdentity ManagementTicketingVulnerability ManagementCommunicationsEDR & XDRIncident ManagementPackage & Container RegistryObservabilityPublic Cloud (Infra)

Select an API first

Authorization

API Key *

You can find or generate your API key in the Unizo Console

---

Ticketing API Explorer

Pre-configured for ticketing operations:

<ApiExplorer 
  defaultCategory="ticketing" 
  defaultEndpoint="POST Create Ticket" 
/>

Select APIPlatformSource Code ManagementIdentity ManagementTicketingVulnerability ManagementCommunicationsEDR & XDRIncident ManagementPackage & Container RegistryObservabilityPublic Cloud (Infra)

Select an API first

Authorization

API Key *

You can find or generate your API key in the Unizo Console

---

Usage in Category Pages

You can embed the API Explorer in any documentation page with pre-configured settings:

---
title: SCM API Testing
---

import ApiExplorer from '@site/src/components/ApiExplorer';

# Test SCM APIs

Try out our Source Code Management APIs directly from this page:

<ApiExplorer 
  defaultCategory="scm" 
  defaultEndpoint="/api/v1/scm/repositories" 
/>

Props

Prop	Type	Description
defaultCategory	string	Pre-select a category. Options: 'scm', 'identity', 'ticketing', 'vms'
defaultEndpoint	string	Pre-select an endpoint. Can use either the full method + summary (e.g., 'GET List Users') or just the path (e.g., '/api/v1/users')

Integration Examples

In a Unified API Page

---
title: Identity API
---

import ApiExplorer from '@site/src/components/ApiExplorer';

## Try it out

Test the Identity API endpoints:

<ApiExplorer defaultCategory="identity" />

In a Tutorial

---
title: Creating Your First Ticket
---

import ApiExplorer from '@site/src/components/ApiExplorer';

## Step 3: Create a Ticket

Now let's create a ticket using the API:

<ApiExplorer 
  defaultCategory="ticketing" 
  defaultEndpoint="POST Create Ticket" 
/>