Update usage overage policy
curl --request PATCH \
--url https://api.watchdog.no/v1/usage/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": {
"mode": "disallowed"
},
"confirmed_billing_impact": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_governing_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
overage: {mode: 'disallowed'},
confirmed_billing_impact: true
})
};
fetch('https://api.watchdog.no/v1/usage/policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/usage/policy"
payload = {
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": { "mode": "disallowed" },
"confirmed_billing_impact": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"current_month": "<string>",
"current_date": "2023-12-25",
"current_period": {
"cadence": "calendar_month",
"anchor_date": "2023-12-25",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z"
},
"billing_timezone": "<string>",
"billing_started": true,
"policy": {
"kind": "none"
},
"governing_revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effective_month": "<string>",
"effective_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z"
},
"upcoming_policies": [
{
"effective_month": "<string>",
"effective_date": "2023-12-25",
"policy": {
"kind": "none"
}
}
]
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The policy changed since you read it, or no policy is configured. Read the policy again before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Usage
Update usage overage policy
Changes the overage setting of the current policy. From GET /v1/usage/policy, send current_period.start_date as expected_period_start_date and governing_revision.id as expected_governing_revision_id so that concurrent changes are rejected. Set confirmed_billing_impact when increasing billable capacity.
Update usage overage policy
curl --request PATCH \
--url https://api.watchdog.no/v1/usage/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": {
"mode": "disallowed"
},
"confirmed_billing_impact": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_governing_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
overage: {mode: 'disallowed'},
confirmed_billing_impact: true
})
};
fetch('https://api.watchdog.no/v1/usage/policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/usage/policy"
payload = {
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": { "mode": "disallowed" },
"confirmed_billing_impact": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"current_month": "<string>",
"current_date": "2023-12-25",
"current_period": {
"cadence": "calendar_month",
"anchor_date": "2023-12-25",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z"
},
"billing_timezone": "<string>",
"billing_started": true,
"policy": {
"kind": "none"
},
"governing_revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effective_month": "<string>",
"effective_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z"
},
"upcoming_policies": [
{
"effective_month": "<string>",
"effective_date": "2023-12-25",
"policy": {
"kind": "none"
}
}
]
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The policy changed since you read it, or no policy is configured. Read the policy again before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).
Headers
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Body
application/json
Response
Current policy after the update.
Pattern:
^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes