How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oso Cloud Policy API

The Policy API from Oso Cloud — 2 operation(s) for policy.

Oso Cloud Policy API is one of 4 APIs that Oso Cloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.osohq.com/api/.

3 operations 2 paths 12 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.osohq.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Oso Cloud Policy API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer e_0123_123_token0123) (ApiKey).

  • ApiKey — Requires an API key to access.

Paths & Operations 3

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

Policy 3
GET
/policy
Gets the currently active policy in Oso Cloud. The policy is expressed as a string containing [Polar](https://www.osohq.com/docs/modeling-in-polar/reference) code.
get_policy 1 param → 200default
POST
/policy
Updates the policy in Oso Cloud. The policy should be represented as a string containing [Polar](https://www.osohq.com/docs/modeling-in-polar/reference) code.
post_policy 3 params body → 200202default
GET
/policy_metadata
Returns metadata about the currently active policy.
get_policy_metadata 1 param → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are TestSummary (3 properties), PolicyTestResult (3 properties), ResourceBlockData (3 properties), PolicyError (2 properties). Each schema is shown below with its type and property counts.

ApiResult
object
1 property 1 required
GetPolicyMetadataResult
object
1 property 1 required
Policy
object
2 properties 1 required
TestSummary
object
Results of executing a single test. Sent to oso-cloud CLI as JSON.
3 properties 3 required
PolicyTestResult
object
Result of a Policy test API request. Sent to oso-cloud CLI as JSON.
3 properties 3 required
PolicyError
object
Error report for a failed Polar policy test, to be displayed to user. Sent to oso-cloud CLI as JSON.
2 properties 2 required
PolicyFailure
All known failure modes for a submitted policy test. Encountering any of these scenarios means the policy test has failed.
GetPolicyResult
object
1 property
PolicyMetadata
object
1 property 1 required
SavePolicyError
ApiError
object
1 property 1 required
ResourceBlockData
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oso-policy-api-openapi.yml Raw ↑

Other APIs Oso Cloud publishes across the network.

Oso Cloud Centralized Authorization Data API
Oso Cloud Check API API
Oso Cloud Local Check API API
Where this information came from

This is an independent, third-party profile of Oso Cloud Policy API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.