Example API responses for every external service that Naftiko Framework capabilities consume. Each JSON file represents the response returned by a specific API endpoint at a specific HTTP method, structured so that the JSONPath mappings in Naftiko capability outputParameters resolve correctly against the example data.
Live site: https://consumes.naftiko.io
Structure: /{service}/{resource-path}/{method}.json
- DevOps and Source Control -- GitHub, GitLab, Docker, Airflow, BrowserStack, Microcks
- Project and Issue Tracking -- Jira, Linear
- Communication -- Slack, Microsoft Teams, Mailchimp
- Knowledge and Documentation -- Notion, Confluence, Google Docs, Google Drive
- CRM and Sales -- Salesforce, HubSpot
- Support and ITSM -- ServiceNow, Zendesk
- Payments and Commerce -- Stripe, Shopify
- Monitoring and Observability -- Datadog, PagerDuty, Sentry, New Relic, Splunk
- Google Cloud and Analytics -- Gmail, Google Calendar, Google Drive (standalone), Google Analytics
- Microsoft Cloud -- Microsoft Teams, Power BI, SharePoint
- Design and Product -- Figma, LinkedIn
- HR and Workforce -- Workday
- AI and ML -- AWS SageMaker
- API Management -- Backstage, Postman, SwaggerHub, Apigee, Azure API Management, Kong, AWS API Gateway
- Governance Services -- API Gateway Analytics, MCP Registry, Security Scanner, Spectral, Observability, LLM Gateway, Identity Service, Cloud Billing, Spec Diff, Backstage (Governance)
baseUri: https://api.github.com | Wiki: Specification, Tutorial, FAQ
| Method | Path | Example |
|---|---|---|
| GET | /repos/{owner}/{repo}/contents/{file_path} |
get.json |
| PUT | /repos/{owner}/{repo}/contents/{file_path} |
put.json |
| GET | /search/code |
get.json |
| POST | /repos/{owner}/{repo}/issues |
post.json |
| POST | /repos/{owner}/{repo}/pulls |
post.json |
| GET | /repos/{owner}/{repo}/pulls |
get.json |
| GET | /repos/{owner}/{repo}/commits |
get.json |
baseUri: https://gitlab.com/api/v4 | Wiki: Specification
| Method | Path | Example |
|---|---|---|
| GET | /projects/{project_id}/pipelines |
get.json |
| GET | /projects/{project_id}/pipelines/{pipeline_id} |
get.json |
| GET | /projects/{project_id}/pipelines/{pipeline_id}/jobs |
get.json |
| GET | /projects/{project_id}/merge_requests |
get.json |
| POST | /projects/{project_id}/merge_requests |
post.json |
baseUri: {docker_host} | Wiki: Installation, FAQ
| Method | Path | Example |
|---|---|---|
| POST | /build |
post.json |
| POST | /images/{image_name}/push |
post.json |
| POST | /containers |
post.json |
baseUri: https://{airflow_host}/api/v1
| Method | Path | Example |
|---|---|---|
| GET | /dags/{dag_id}/dagRuns |
get.json |
| POST | /dags/{dag_id}/dagRuns |
post.json |
| GET | /dags/{dag_id}/dagRuns/{dag_run_id} |
get.json |
| GET | /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances |
get.json |
baseUri: https://api.browserstack.com/automate
| Method | Path | Example |
|---|---|---|
| GET | /builds.json |
get.json |
| GET | /builds/{build_id}/sessions.json |
get.json |
| GET | /sessions/{session_id}.json |
get.json |
baseUri: {microcks_base_url}/api
| Method | Path | Example |
|---|---|---|
| POST | /artifact/upload |
post.json |
| GET | /services |
get.json |
| POST | /tests |
post.json |
baseUri: https://{domain}.atlassian.net/rest/api/3
| Method | Path | Example |
|---|---|---|
| POST | /issue |
post.json |
| GET | /issue/{issue_id} |
get.json |
| PUT | /issue/{issue_id} |
put.json |
| GET | /issue/search |
get.json |
| POST | /issue/{issue_id}/comment |
post.json |
baseUri: https://api.linear.app
| Method | Path | Example |
|---|---|---|
| POST | /graphql |
post.json |
baseUri: https://slack.com/api | Wiki: Specification
| Method | Path | Example |
|---|---|---|
| POST | /chat.postMessage |
post.json |
| GET | /conversations.list |
get.json |
| GET | /conversations.history |
get.json |
baseUri: https://graph.microsoft.com/v1.0
| Method | Path | Example |
|---|---|---|
| POST | /teams/{team_id}/channels/{channel_id}/messages |
post.json |
| POST | /chats/{chat_id}/messages |
post.json |
| GET | /me/chats |
get.json |
baseUri: https://us1.api.mailchimp.com/3.0
| Method | Path | Example |
|---|---|---|
| POST | /campaigns |
post.json |
| GET | /campaigns |
get.json |
| POST | /campaigns/{campaign_id}/actions/send |
post.json |
| GET | /reports/{campaign_id}/email-activity |
get.json |
| POST | /lists/{list_id}/members |
post.json |
baseUri: https://api.notion.com/v1 | Wiki: Tutorial, Specification, FAQ
| Method | Path | Example |
|---|---|---|
| POST | /databases/{database_id}/query |
post.json |
| POST | /pages |
post.json |
| GET | /pages/{page_id} |
get.json |
| PATCH | /pages/{page_id} |
patch.json |
| POST | /search |
post.json |
baseUri: https://{domain}.atlassian.net/wiki/rest/api
| Method | Path | Example |
|---|---|---|
| POST | /content |
post.json |
| GET | /content |
get.json |
| GET | /content/{page_id} |
get.json |
| PUT | /content/{page_id} |
put.json |
baseUri: https://docs.googleapis.com/v1
| Method | Path | Example |
|---|---|---|
| GET | /documents/{document_id} |
get.json |
| POST | /documents/{document_id}:batchUpdate |
post.json |
baseUri: https://www.googleapis.com/drive/v3
| Method | Path | Example |
|---|---|---|
| GET | /files |
get.json |
| GET | /files/{file_id} |
get.json |
baseUri: https://{instance}.salesforce.com/services/data/v59.0
| Method | Path | Example |
|---|---|---|
| GET | /query |
get.json |
| POST | /sobjects/{object_type} |
post.json |
| GET | /sobjects/{object_type}/{record_id} |
get.json |
| PATCH | /sobjects/{object_type}/{record_id} |
patch.json |
baseUri: https://api.hubapi.com/crm/v3
| Method | Path | Example |
|---|---|---|
| POST | /objects/contacts |
post.json |
| GET | /objects/contacts/{contact_id} |
get.json |
| PATCH | /objects/contacts/{contact_id} |
patch.json |
| POST | /objects/contacts/search |
post.json |
| POST | /objects/deals |
post.json |
baseUri: https://{instance}.service-now.com/api/now
| Method | Path | Example |
|---|---|---|
| POST | /table/incident |
post.json |
| GET | /table/incident |
get.json |
| GET | /table/incident/{sys_id} |
get.json |
| PATCH | /table/incident/{sys_id} |
patch.json |
baseUri: https://{subdomain}.zendesk.com/api/v2
| Method | Path | Example |
|---|---|---|
| POST | /tickets |
post.json |
| GET | /tickets/{ticket_id} |
get.json |
| PUT | /tickets/{ticket_id} |
put.json |
| GET | /search |
get.json |
baseUri: https://api.stripe.com/v1
| Method | Path | Example |
|---|---|---|
| POST | /customers |
post.json |
| GET | /customers |
get.json |
| POST | /customers/{customer_id} |
post.json |
| POST | /payment_intents |
post.json |
| GET | /payment_intents |
get.json |
| POST | /subscriptions |
post.json |
| GET | /subscriptions |
get.json |
baseUri: https://{store}.myshopify.com/admin/api/2024-01
| Method | Path | Example |
|---|---|---|
| GET | /orders.json |
get.json |
| GET | /orders/{order_id}.json |
get.json |
| GET | /products.json |
get.json |
baseUri: https://api.datadoghq.com
| Method | Path | Example |
|---|---|---|
| GET | /api/v1/query |
get.json |
| GET | /api/v1/monitor |
get.json |
| GET | /api/v1/monitor/{monitor_id} |
get.json |
| GET | /api/v1/events |
get.json |
baseUri: https://api.pagerduty.com
| Method | Path | Example |
|---|---|---|
| GET | /incidents |
get.json |
| POST | /incidents |
post.json |
| GET | /incidents/{incident_id} |
get.json |
| PUT | /incidents/{incident_id} |
put.json |
| GET | /oncalls |
get.json |
baseUri: https://sentry.io/api/0
| Method | Path | Example |
|---|---|---|
| GET | /projects/{org_slug}/{project_slug}/issues/ |
get.json |
| GET | /organizations/{org_slug}/issues/{issue_id}/ |
get.json |
| PUT | /organizations/{org_slug}/issues/{issue_id}/ |
put.json |
| GET | /organizations/{org_slug}/issues/{issue_id}/events/ |
get.json |
baseUri: https://api.newrelic.com/v2
| Method | Path | Example |
|---|---|---|
| POST | /applications/{application_id}/deployments.json |
post.json |
| GET | /applications.json |
get.json |
| GET | /alerts_violations.json |
get.json |
baseUri: https://{splunk_host}:8089/services
| Method | Path | Example |
|---|---|---|
| POST | /search/jobs |
post.json |
| GET | /search/jobs/{sid}/results |
get.json |
| GET | /alerts/fired_alerts |
get.json |
| GET | /alerts/fired_alerts/{alert_name} |
get.json |
| GET | /saved/searches |
get.json |
baseUri: https://gmail.googleapis.com/gmail/v1
| Method | Path | Example |
|---|---|---|
| POST | /users/me/messages/send |
post.json |
| GET | /users/me/messages |
get.json |
baseUri: https://www.googleapis.com/calendar/v3
| Method | Path | Example |
|---|---|---|
| POST | /calendars/{calendar_id}/events |
post.json |
| GET | /calendars/{calendar_id}/events |
get.json |
baseUri: https://www.googleapis.com/drive/v3
| Method | Path | Example |
|---|---|---|
| GET | /files |
get.json |
| GET | /files/{file_id} |
get.json |
| PATCH | /files/{file_id} |
patch.json |
| POST | /files/{file_id}/permissions |
post.json |
baseUri: https://analyticsdata.googleapis.com/v1beta
| Method | Path | Example |
|---|---|---|
| POST | /properties/{property_id}:runReport |
post.json |
| POST | /properties/{property_id}:runRealtimeReport |
post.json |
baseUri: https://api.powerbi.com/v1.0/myorg
| Method | Path | Example |
|---|---|---|
| GET | /reports |
get.json |
| GET | /reports/{report_id} |
get.json |
| GET | /dashboards |
get.json |
| POST | /datasets/{dataset_id}/refreshes |
post.json |
| POST | /datasets/{dataset_id}/executeQueries |
post.json |
baseUri: https://graph.microsoft.com/v1.0
| Method | Path | Example |
|---|---|---|
| GET | /sites |
get.json |
| POST | /sites/{site_id}/drive/root:/{folder_path}:/children |
post.json |
| GET | /sites/{site_id}/drives |
get.json |
baseUri: https://api.figma.com/v1 | Wiki: Specification
| Method | Path | Example |
|---|---|---|
| GET | /files/{file_key} |
get.json |
| GET | /files/{file_key}/comments |
get.json |
| POST | /files/{file_key}/comments |
post.json |
| GET | /files/{file_key}/versions |
get.json |
| GET | /teams/{team_id}/projects |
get.json |
baseUri: https://api.linkedin.com/v2
| Method | Path | Example |
|---|---|---|
| GET | /people/(id:{member_urn}) |
get.json |
| GET | /organizations/{org_id} |
get.json |
baseUri: https://wd2-impl-services1.workday.com/ccx/api/v1
| Method | Path | Example |
|---|---|---|
| GET | /workers |
get.json |
| GET | /workers/{worker_id} |
get.json |
| GET | /organizations/{org_id} |
get.json |
baseUri: https://api.sagemaker.{region}.amazonaws.com
| Method | Path | Example |
|---|---|---|
| POST | / (all operations via X-Amz-Target header) |
post.json |
baseUri: {backstage_base_url}/api/catalog | Wiki: Roadmap
| Method | Path | Example |
|---|---|---|
| GET | /entities |
get.json |
| GET | /entities/by-name/{kind}/{namespace}/{name} |
get.json |
| PUT | /entities/by-name/{kind}/{namespace}/{name} |
put.json |
baseUri: https://api.getpostman.com
| Method | Path | Example |
|---|---|---|
| GET | /collections |
get.json |
| GET | /collections/{collection_id} |
get.json |
| GET | /environments |
get.json |
baseUri: https://api.swaggerhub.com
| Method | Path | Example |
|---|---|---|
| GET | /apis/{owner} |
get.json |
| GET | /apis/{owner}/{api_name} |
get.json |
| GET | /apis/{owner}/{api_name}/{version} |
get.json |
baseUri: https://apigee.googleapis.com/v1/organizations/{organization}
| Method | Path | Example |
|---|---|---|
| GET | /apis |
get.json |
| GET | /apis/{api_name} |
get.json |
| GET | /apiproducts |
get.json |
| GET | /environments/{environment}/deployments |
get.json |
baseUri: https://management.azure.com/.../Microsoft.ApiManagement/service/{service_name}
| Method | Path | Example |
|---|---|---|
| GET | /apis |
get.json |
| GET | /apis/{api_id}/operations |
get.json |
| GET | /products |
get.json |
baseUri: {kong_admin_url}
| Method | Path | Example |
|---|---|---|
| GET | /services |
get.json |
| GET | /services/{service_id} |
get.json |
| GET | /services/{service_id}/routes |
get.json |
| GET | /routes |
get.json |
| GET | /plugins |
get.json |
baseUri: https://apigateway.{region}.amazonaws.com
| Method | Path | Example |
|---|---|---|
| GET | /restapis |
get.json |
| GET | /restapis/{api_id}/resources |
get.json |
| GET | /restapis/{api_id}/resources/{resource_id}/methods/{http_method} |
get.json |
| GET | /restapis/{api_id}/stages |
get.json |
| GET | /restapis/{api_id}/models |
get.json |
| GET | /restapis/{api_id}/stages/{stage_name}/exports/{export_type} |
get.json |
These are internal or configurable services used by Naftiko's governance capabilities.
baseUri: {API_GATEWAY_ANALYTICS_URL}
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/analytics/usage |
post.json |
| POST | /api/v1/analytics/costs |
post.json |
| GET | /api/v1/analytics/health |
get.json |
| POST | /api/v1/apis/status |
post.json |
| GET | /api/v1/security/events |
get.json |
baseUri: {MCP_REGISTRY_URL}
| Method | Path | Example |
|---|---|---|
| GET | /api/v1/servers/{server_url} |
get.json |
| POST | /api/v1/stats |
post.json |
| POST | /api/v1/policy/vendor |
post.json |
| POST | /api/v1/registry/diff |
post.json |
baseUri: {SECURITY_SCANNER_URL}
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/analyze/tools |
post.json |
| POST | /api/v1/analyze/endpoints |
post.json |
| POST | /api/v1/classify |
post.json |
| POST | /api/v1/scan/spec |
post.json |
| POST | /api/v1/assess/auth |
post.json |
| POST | /api/v1/assess |
post.json |
| POST | /api/v1/assess/batch |
post.json |
baseUri: {SPECTRAL_SERVICE_URL} | Wiki: Roadmap
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/lint |
post.json |
| POST | /api/v1/validate |
post.json |
| POST | /api/v1/lint/batch |
post.json |
| POST | /api/v1/detect |
post.json |
| POST | /api/v1/drift |
post.json |
baseUri: {OBSERVABILITY_URL}
| Method | Path | Example |
|---|---|---|
| GET | /api/v1/traces |
get.json |
baseUri: {LLM_GATEWAY_URL}
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/costs |
post.json |
baseUri: {IDENTITY_SERVICE_URL}
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/identity/extract |
post.json |
| POST | /api/v1/identity/verify-obo |
post.json |
| POST | /api/v1/identity/detect-escalation |
post.json |
| POST | /api/v1/agents/permissions |
post.json |
| POST | /api/v1/agents/permission-risk |
post.json |
baseUri: {CLOUD_BILLING_URL}
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/costs/by-label |
post.json |
baseUri: {SPEC_DIFF_SERVICE_URL}
| Method | Path | Example |
|---|---|---|
| POST | /api/v1/diff/analyze |
post.json |
| POST | /api/v1/diff/impact |
post.json |
baseUri: {BACKSTAGE_BASE_URL} | Extended catalog used by governance capabilities.
| Method | Path | Example |
|---|---|---|
| GET | /api/search/query |
get.json |
| GET | /api/catalog/entities/by-name/{entity_ref} |
get.json |
| GET | /api/catalog/entity-facets |
get.json |
| GET | /api/catalog/entities/by-name/{entity_ref}/relations |
get.json |
| GET | /api/catalog/entities/by-name/{entity_ref}/scorecards |
get.json |
| POST | /api/catalog/relations/counts |
post.json |
| POST | /api/catalog/scorecards/batch |
post.json |
| POST | /api/catalog/entities/owners |
post.json |
| GET | /api/catalog/entities |
get.json |
| POST | /api/catalog/entities |
post.json |
| GET | /api/catalog/relations |
get.json |
Each JSON file represents the raw response an API returns before Naftiko applies outputParameters mappings. In the Naftiko Specification, the consumes section of a capability YAML declares:
- A
baseUriandnamespacefor the upstream API resourceswithpathtemplates andoperationswith HTTP methodsoutputParameterswith JSONPathmappingorvalueexpressions
These example responses let you verify that every JSONPath expression in a capability's output mappings resolves to the correct field. They serve as the reference data for wiki tutorials, specification examples, and capability development.
| Page | What It Covers |
|---|---|
| Tutorial | Step-by-step guide consuming the Notion API -- forwarding, filtering, multi-step, and MCP |
| Specification | Full spec with GitHub, Notion, Slack, and Figma consume examples |
| FAQ | Common patterns for GitHub and Notion consumption |
| Use Cases | Architecture patterns: elevate APIs, compose context, rightsize microservices |
| Spec-Driven Integration | The consume/expose duality and how capabilities bridge APIs |
| Installation | Running the engine with Docker to serve capabilities |
| Roadmap | Planned integrations: Backstage plugin, Spectral linting, VS Code extension |