2. APIs

Deployment — Kubernetes & UCS appliance

This chapter applies to both, the Kubernetes and the UCS appliance deployment.

This chapter documents various APIs in Nubus that you can use for customization purposes. It addresses software developers.

Contents

• 2.1. Central Navigation API
  • 2.1.1. Authentication
  • 2.1.2. Request and response
  • 2.1.3. Deactivate API
• 2.2. UDM HTTP REST API
  • 2.2.1. API location
  • 2.2.2. Authentication
  • 2.2.3. Authorization groups
    • 2.2.3.1. Add authorization group in Nubus for Kubernetes
    • 2.2.3.2. Add authorization group in Nubus for UCS
  • 2.2.4. API methods
    • 2.2.4.1. Object modification with PATCH and PUT
    • 2.2.4.2. Conditional requests with entity tags
  • 2.2.5. API response codes
  • 2.2.6. Usage examples
    • 2.2.6.1. Templates for UDM modules
    • 2.2.6.2. Create a user object
    • 2.2.6.3. Search for a user object
    • 2.2.6.4. Modify a user object
    • 2.2.6.5. Delete a user object
• 2.3. Provisioning API
  • 2.3.1. Consumer lifecycle
  • 2.3.2. Access to Provisioning API endpoint
  • 2.3.3. OpenAPI schema
  • 2.3.4. Obtain administrative credentials
  • 2.3.5. Create subscription
  • 2.3.6. Consumer workflow
  • 2.3.7. Query Event object
  • 2.3.8. Confirm Event object
  • 2.3.9. Bundle the consumer as artifact