Nirmata Documentation
  • Home
  • docs
    Introduction Alarms Applications Catalog CloudProviders Clusters Host Groups Integrations Private Edition Release Documentation Rest API Settings Use Cases Workload Policies
  • release
    V2.11
  • Rest API
    • API Compatibility
    • API Basics
      • Authentication
      • Operations
      • HTTP Response Code Status
      • Resources
    • HTTP Headers
    • URL Parameters
      • mode
      • query
      • fields
      • excludeFields
      • count
      • start
    • Common Endpoints
      • descendants
      • ancestors
      • ancestor
      • currentAlarms
      • currentAlarmCounts
    • Resource Paths
    • Sample Operations
      • Get all Catalog Applications
      • Get Deployment Details
      • Create a direct-connect host-group
      • Create an Application
      • Delete an Application
      • Get the UUID of an Application named 'helloworld' in YAML format
      • Get all running Applications' IDs, names, and states
      • Create a new Environment
      • Run an Application in an Environment
      • Find all Deployments and replica counts in running Applications
      • Scale a Deployment in a running Application
      • Get the image versions for a container
      • Update image version for a running container
      • Select a PodTemplateSpec and output as YAML
      • Terraform Provider For Cluster Creation on Direct Connected Hosts
      • Add Nirmata controller to a cluster
      • Apply YAML updates to a running Application
      • Get CPU and memory usage for all Clusters
      • Get select properties of all hosts
      • Create a new Direct Connect Cluster
      • Query a cluster's state
      • Discover attributes and relations
      • Discover the REST API schema
  • Nirmata Documentation
  • Rest API
  • API Compatibility

API Compatibility

The API is currently in development and is likely to change. Although we will strive to maintain compatibility, some changes may break existing integrations.

Rest API API Basics

© Copyright 2020, Nirmata.