Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

nOps Essentials Scheduler API

Endpoints for managing the nOps Essentials scheduler, which automates resource management tasks like starting and stopping non-production workloads to reduce costs.

nOps Essentials Scheduler API is one of 2 APIs that nOps publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Essentials Scheduler. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 8 operations across 8 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://app.nops.io.

8 operations 8 paths 2 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://app.nops.io
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

nOps Essentials Scheduler API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Nops-Api-Key (ApiKeyAuth). An API key is passed in the header as x-nops-signature (SignatureAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated from the nOps console under Organization Settings. Include this key in the X-Nops-Api-Key header for all requests.
  • SignatureAuth — Encoded signature for enhanced security. Created using a public/private key pair configured in the nOps console.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Essentials Scheduler 8

Endpoints for managing the nOps Essentials scheduler, which automates resource management tasks like starting and stopping non-production workloads to reduce costs.

GET
/svc/k8s_cost/recommendations/essentials/scheduler/workload/
Nops Get Scheduler Workload Recommendations
getSchedulerWorkloadRecommendations 3 params → 200401
GET
/svc/k8s_cost/recommendations/essentials/scheduler/workload/summary/
Nops Get Scheduler Workload Summary
getSchedulerWorkloadSummary 2 params → 200401
GET
/svc/k8s_cost/recommendations/essentials/scheduler/utilization/
Nops Get Scheduler Utilization Recommendations
getSchedulerUtilizationRecommendations 3 params → 200401
GET
/svc/k8s_cost/recommendations/essentials/scheduler/utilization/summary/
Nops Get Scheduler Utilization Summary
getSchedulerUtilizationSummary 2 params → 200401
POST
/svc/notifications/scheduler/nops_scheduler
Nops Create a Scheduler
createScheduler body → 201400401
POST
/svc/notifications/scheduler/{id}/trigger
Nops Manually Trigger a Scheduler
triggerScheduler 1 param → 200401404
POST
/svc/notifications/scheduler/{id}/enable
Nops Enable a Scheduler
enableScheduler 1 param → 200401404
POST
/svc/notifications/scheduler/{id}/disable
Nops Disable a Scheduler
disableScheduler 1 param → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Scheduler (5 properties), SchedulerCreateRequest (4 properties). Each schema is shown below with its type and property counts.

SchedulerCreateRequest
object
4 properties
Scheduler
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nops-essentials-scheduler-api-openapi.yml Raw ↑

Other APIs nOps publishes across the network.

nOps MAP Migration API