@gpuai/sdk 0.3.13 → 0.3.15

package/docs/BillingApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.gpu.ai/v1*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**createCryptoDeposit**](BillingApi.md#createcryptodepositoperation) | **POST** /billing/deposits/crypto | Create a stablecoin deposit |
+| [**getBalance**](BillingApi.md#getbalance) | **GET** /billing/balance | Get the org credit balance |
 | [**getDeposit**](BillingApi.md#getdeposit) | **GET** /billing/deposits/{id} | Get one stablecoin deposit |
 | [**getSpendingLimit**](BillingApi.md#getspendinglimit) | **GET** /billing/spending-limit | Get the org spending limit |
 | [**listDeposits**](BillingApi.md#listdeposits) | **GET** /billing/deposits | List stablecoin deposits |
@@ -89,6 +90,71 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getBalance
+
+> Balance getBalance()
+
+Get the org credit balance
+
+Returns the organization\'s credit balance, its auto-pay configuration, and the live burn rate. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  Divide `balance_cents` by `burn_cents_per_hour` for the remaining runway in hours. The quotient is undefined in three cases a caller must keep apart: `burn_cents_per_hour` is 0 (nothing running, so the balance funds unbounded idle time), it is `null` (the burn rate could not be determined — NOT the same as idle), or the balance is already at or below zero.  This is the balance itself — for spend against a configured cap see `/billing/spending-limit`, and for past consumption see `/usage`. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@gpuai/sdk';
+import type { GetBalanceRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  try {
+    const data = await api.getBalance();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Balance**](Balance.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getDeposit
 
 > CryptoDeposit getDeposit(id)

package/docs/MarketApi.md

@@ -0,0 +1,98 @@
+# MarketApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMarketHistory**](MarketApi.md#getmarkethistory) | **GET** /market-history | Get a GPU\'s price and availability over time |
+
+
+
+## getMarketHistory
+
+> MarketHistoryResponse getMarketHistory(gpuModel, region, capacityClass, bucket, from, to)
+
+Get a GPU\'s price and availability over time
+
+Returns GPU.ai\'s own price and obtainable capacity for one GPU model over a window, at 15-minute or daily resolution. Requires the `market:read` scope (or `full_access`).  THE NULL CONTRACT. `price_per_gpu_hour` and `available_count` are nullable, and the two states are different facts that must not be collapsed:  * a real `0` means we sampled that bucket and the market was sold out; * `null` means we did NOT sample that bucket — a failed poll, a skipped cycle, an incident on our side. It says nothing about supply.  The response materializes the full bucket grid across the window, so a gap has visible width. Do not interpolate across a null: that asserts a continuity the data does not have, and reading one as a zero reports our own outages as supplier stockouts.  PER-GPU NORMALIZATION. `price_per_gpu_hour` is always a per-GPU rate. When it was divided out of a whole-node price, `node_price_per_hour` and `gpu_count` are present and describe that derivation; they are absent for single-GPU capacity. A per-GPU figure presented without that context implies single-GPU rentability that whole-node capacity does not offer.  WINDOW CAPS. `bucket=1d` is capped at 365 days (the retention window). `bucket=15m` is capped at 90 days when BOTH `region` and `capacity_class` are supplied, and at 31 days when either is omitted, because an unscoped 15-minute series scans every region and class in every bucket. An over-wide window is a 400 naming the cap and both escapes, never a silent truncation.  This series carries no upstream supplier identity of any kind: the price is GPU.ai\'s own floor and the count is an aggregate. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MarketApi,
+} from '@gpuai/sdk';
+import type { GetMarketHistoryRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MarketApi(config);
+
+  const body = {
+    // string | GPU model to chart, e.g. \"H100\". Required — it is the leading column of the lookup index.
+    gpuModel: gpuModel_example,
+    // string | Canonical region to narrow the series to. Omit to MERGE every region rather than to filter on the empty string. (optional)
+    region: region_example,
+    // 'secure' | 'community' | Capacity class to narrow the series to. Omit to merge both. (optional)
+    capacityClass: capacityClass_example,
+    // '15m' | '1d' | Resolution. Only these two values are accepted: the series cannot be returned finer than it was stored. (optional)
+    bucket: bucket_example,
+    // Date | Start of the window (RFC3339). Defaults to 7 days before `to`. (optional)
+    from: 2013-10-20T19:20:30+01:00,
+    // Date | End of the window (RFC3339). Defaults to now; a future value is clamped to now, since no bucket can exist for a time that has not happened. (optional)
+    to: 2013-10-20T19:20:30+01:00,
+  } satisfies GetMarketHistoryRequest;
+
+  try {
+    const data = await api.getMarketHistory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **gpuModel** | `string` | GPU model to chart, e.g. \"H100\". Required — it is the leading column of the lookup index. | [Defaults to `undefined`] |
+| **region** | `string` | Canonical region to narrow the series to. Omit to MERGE every region rather than to filter on the empty string. | [Optional] [Defaults to `undefined`] |
+| **capacityClass** | `secure`, `community` | Capacity class to narrow the series to. Omit to merge both. | [Optional] [Defaults to `undefined`] [Enum: secure, community] |
+| **bucket** | `15m`, `1d` | Resolution. Only these two values are accepted: the series cannot be returned finer than it was stored. | [Optional] [Defaults to `'15m'`] [Enum: 15m, 1d] |
+| **from** | `Date` | Start of the window (RFC3339). Defaults to 7 days before `to`. | [Optional] [Defaults to `undefined`] |
+| **to** | `Date` | End of the window (RFC3339). Defaults to now; a future value is clamped to now, since no bucket can exist for a time that has not happened. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**MarketHistoryResponse**](MarketHistoryResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Validation failed — a missing `gpu_model`, a non-canonical region, an unknown `capacity_class` or `bucket`, a non-RFC3339 timestamp, a `from` that is not before `to`, or a window wider than the cap for the requested resolution and scope. The detail names the cap and both ways to stay under it.  |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/MarketHistoryPoint.md

@@ -0,0 +1,43 @@
+
+# MarketHistoryPoint
+
+One bucket of a price/stock series.  The nullability of `price_per_gpu_hour` and `available_count` is the contract, not a convenience: a real 0 is a bucket we sampled and found sold out, and null is a bucket we never successfully sampled. A client that coerces null to 0 will report GPU.ai\'s own polling outages as supplier stockouts, and must not interpolate across a null. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bucketTs` | Date
+`pricePerGpuHour` | number
+`availableCount` | number
+`nodePricePerHour` | number
+`gpuCount` | number
+
+## Example
+
+```typescript
+import type { MarketHistoryPoint } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bucketTs": null,
+  "pricePerGpuHour": null,
+  "availableCount": null,
+  "nodePricePerHour": null,
+  "gpuCount": null,
+} satisfies MarketHistoryPoint
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MarketHistoryPoint
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MarketHistoryResponse.md

@@ -0,0 +1,43 @@
+
+# MarketHistoryResponse
+
+A price/stock series for one (gpu_model, region, capacity_class) key.  Points cover the FULL bucket grid across the requested window, including the buckets we did not sample — a gap therefore has visible width rather than disappearing between two adjacent points. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gpuModel` | string
+`region` | string
+`capacityClass` | string
+`bucketSeconds` | number
+`points` | [Array<MarketHistoryPoint>](MarketHistoryPoint.md)
+
+## Example
+
+```typescript
+import type { MarketHistoryResponse } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gpuModel": null,
+  "region": null,
+  "capacityClass": null,
+  "bucketSeconds": null,
+  "points": null,
+} satisfies MarketHistoryResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MarketHistoryResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WatchApi.md

@@ -0,0 +1,389 @@
+# WatchApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createWatchRule**](WatchApi.md#createwatchrule) | **POST** /watch-rules | Create a watch rule |
+| [**deleteWatchRule**](WatchApi.md#deletewatchrule) | **DELETE** /watch-rules/{id} | Delete a watch rule |
+| [**getWatchRule**](WatchApi.md#getwatchrule) | **GET** /watch-rules/{id} | Get a watch rule |
+| [**listWatchRules**](WatchApi.md#listwatchrules) | **GET** /watch-rules | List watch rules |
+| [**updateWatchRule**](WatchApi.md#updatewatchrule) | **PATCH** /watch-rules/{id} | Update a watch rule |
+
+
+
+## createWatchRule
+
+> WatchRule createWatchRule(watchRuleCreate, idempotencyKey)
+
+Create a watch rule
+
+Creates a rule that notifies you when the market moves on a GPU model. Requires the `watch:write` scope (or `full_access`).  A watch rule ONLY notifies. It cannot launch capacity and cannot spend money: there is no field on this resource that provisions anything. Automatic launching is a separate resource with its own spend-consent gate.  Targeting is dimensional — a GPU model plus optional canonical region and capacity class. It is deliberately NOT possible to pin a rule to a specific catalog listing: listing identity is unstable, so a pinned rule can silently match nothing and never fire.  Delivery is to the organization\'s registered webhook endpoints, plus an email to the rule\'s creator. `webhook_endpoint_override_id` routes one rule to one specific endpoint and is the id of an endpoint already registered via `/webhook-endpoints` — the resource accepts no URL of any kind.  Organizations are limited to 50 ENABLED rules; the 422 names the limit. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { CreateWatchRuleRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WatchApi(config);
+
+  const body = {
+    // WatchRuleCreate
+    watchRuleCreate: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies CreateWatchRuleRequest;
+
+  try {
+    const data = await api.createWatchRule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **watchRuleCreate** | [WatchRuleCreate](WatchRuleCreate.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WatchRule**](WatchRule.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+| **422** | Validation failed — an unknown condition kind, a non-canonical region, a missing threshold on a threshold condition, an override id that is not an endpoint registered by this organization, a field naming a catalog listing or a delivery address, or the enabled-rule limit already reached.  |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteWatchRule
+
+> deleteWatchRule(id)
+
+Delete a watch rule
+
+Deletes a watch rule. Requires the &#x60;watch:write&#x60; scope (or &#x60;full_access&#x60;). Deleting an already-deleted rule returns 404. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { DeleteWatchRuleRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WatchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteWatchRuleRequest;
+
+  try {
+    const data = await api.deleteWatchRule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Deleted |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWatchRule
+
+> WatchRule getWatchRule(id)
+
+Get a watch rule
+
+Fetches one watch rule. Requires the &#x60;watch:read&#x60; scope (or &#x60;full_access&#x60;). A rule belonging to another organization returns 404 — the same answer as an id that does not exist. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { GetWatchRuleRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WatchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetWatchRuleRequest;
+
+  try {
+    const data = await api.getWatchRule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**WatchRule**](WatchRule.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listWatchRules
+
+> WatchRulePage listWatchRules(cursor, limit)
+
+List watch rules
+
+Lists this organization\&#39;s watch rules. Requires the &#x60;watch:read&#x60; scope (or &#x60;full_access&#x60;). Rules belonging to other organizations are never returned. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { ListWatchRulesRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WatchApi(config);
+
+  const body = {
+    // string (optional)
+    cursor: cursor_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListWatchRulesRequest;
+
+  try {
+    const data = await api.listWatchRules(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `50`] |
+
+### Return type
+
+[**WatchRulePage**](WatchRulePage.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateWatchRule
+
+> WatchRule updateWatchRule(id, watchRuleUpdate)
+
+Update a watch rule
+
+Partially updates a watch rule. Requires the &#x60;watch:write&#x60; scope (or &#x60;full_access&#x60;).  An ABSENT key keeps the stored value; an explicit &#x60;null&#x60; on &#x60;region&#x60;, &#x60;capacity_class&#x60; or &#x60;webhook_endpoint_override_id&#x60; CLEARS it back to \&quot;any\&quot; / \&quot;organization default\&quot;. The two are distinguished by which keys the body carries, so send only the keys you mean to change.  Editing a rule RE-ARMS it: the fired latch describes the condition that was replaced, so carrying it across an edit would suppress the first alert on the new one. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { UpdateWatchRuleRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WatchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // WatchRuleUpdate
+    watchRuleUpdate: ...,
+  } satisfies UpdateWatchRuleRequest;
+
+  try {
+    const data = await api.updateWatchRule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **watchRuleUpdate** | [WatchRuleUpdate](WatchRuleUpdate.md) |  | |
+
+### Return type
+
+[**WatchRule**](WatchRule.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **422** | Validation failed against the MERGED rule — for example switching to a threshold condition on a rule that has no stored threshold.  |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+