netorca-sdk 1.0.12

A Python SDK for interacting with the NetOrca API

NetOrca SDK

The official Python SDK for the NetOrca API. Build automation pipelines, manage services, and integrate NetOrca into your CI/CD workflows with a clean, fully typed Python interface.

---

Installation

pip install netorca-sdk

Requirements: Python 3.8+

---

Client Initialisation

from netorca_sdk import NetOrcaClient

client = NetOrcaClient(
    fqdn="https://your-instance.netorca.io/v1",
    api_key="YOUR_API_KEY",
)

The context parameter controls which point-of-view the client operates from:

# Service owner context (default)
client = NetOrcaClient(fqdn="...", api_key="...", context="serviceowner")

# Consumer context
client = NetOrcaClient(fqdn="...", api_key="...", context="consumer")

Parameter	Type	Default	Description
fqdn	str	required	Base URL of your NetOrca instance
api_key	str	required	Your NetOrca API key
context	str	"serviceowner"	Point-of-view: "serviceowner" or "consumer"
verify_ssl	bool	True	Verify SSL certificates on requests
verify_auth	bool	True	Validate the API key on initialisation

---

Available Resources

Property	Description
client.services	Service catalogue
client.service_items	Service item instances
client.deployed_items	Deployed item records
client.change_instances	Change requests and lifecycle events
client.service_configs	Service configuration snapshots
client.charges	Billing and charge records
client.applications	Consumer applications
client.submissions	Submission records
client.healthchecks	Service healthcheck endpoints
client.webhooks	Webhook registrations
client.ai_processors	AI processor definitions
client.ai_documents	AI context documents
client.pack_profiles	Pack profile configurations
client.llm_models	LLM model registrations

---

Full Documentation

docs.netorca.io/sdk_guide/introduction

---

License

MIT License